From fe255c2008487f41d3397c1a9c9cd952a5b84d75 Mon Sep 17 00:00:00 2001 From: mobinmob Date: Sat, 17 Aug 2024 18:41:33 +0300 Subject: /doc : adding corrections by @AngMits. https://codeberg.org/AngMits --- doc/apkg.conf.md | 10 +++++----- doc/apkg.md | 22 ++++++++++------------ doc/revdep.md | 11 ++++++----- 3 files changed, 21 insertions(+), 22 deletions(-) diff --git a/doc/apkg.conf.md b/doc/apkg.conf.md index 83f4277..6623016 100644 --- a/doc/apkg.conf.md +++ b/doc/apkg.conf.md @@ -2,19 +2,18 @@ **apkg.conf** - configuration file for apkg - # DESCRIPTION + **apkg.conf** is the configuration file for the **apkg** package manager for the alice linux distribution. It resides by default under /etc in an alice linux installation. -The contends are sourced by the **apkg** script and are in the posix shell *key="value"* format. - +The contents are sourced by the **apkg** script and are in the posix shell *key="value"* format. # CONFIGURATION KEYS -- **APKG_NOPROMPT** If set, it enabled non-interactive use by disabling user confirmation prompt. +- **APKG_NOPROMPT** If set, it enables non-interactive use by disabling user confirmation prompt. - **APKG_PACKAGE_DIR** Directory where the compiled packages will reside. - **APKG_SOURCE_DIR** Directory that will hold the downloaded sources. -- **APKG_WORK_DIR** Directory where the actuall building proccess will take place. This happens in subdirectories which are cleaned after completion. +- **APKG_WORK_DIR** Directory where the actual building process will take place. This happens in subdirectories which are cleaned after completion. - **APKG_LOG** If set, it enables the creation of a log for the program output. - **export CFLAGS=""** Default are *-O3 -march=x86-64 -pipe* - **export CXXFLAGS="$CFLAGS"** @@ -26,5 +25,6 @@ The contends are sourced by the **apkg** script and are in the posix shell *key= **apkg** is in a working stage but also under heavy development. Please report and bugs/issues in the project issue tracker: https://codeberg.org/emmett1/autils/issues # AUTHORS + emmett1 Author of the program and creator of alice linux. mobinmob Author of the man page. diff --git a/doc/apkg.md b/doc/apkg.md index e3dbe57..45d5604 100644 --- a/doc/apkg.md +++ b/doc/apkg.md @@ -3,29 +3,26 @@ **apkg** - package building tool and package manager for alice linux # SYNOPSIS - + **apkg** [-i] [-I] [-d] [-D] [-j] [-u] [-r] [-t] [-U ] [-f] [-o] [-p] [-s] [-h] [*pkg(s)*] - + # DESCRIPTION - -**apkg** is the package build tool and package installer, along with **spm** for the alice linux destribution. + +**apkg** is the package build tool and package installer, along with **spm** for the alice linux distribution. It is written in posix shell with the goal to be simple and effective. It can consume package building templates in the abuild format and automate the building and installing of packages. - + # OPTIONS - Arguments for apkg are as follows: - + - **-h** Prints help. - **-i** ** Installs package(s) without taking dependencies into account. Building will fail if the dependencies are not present in the system. - **-I** ** Installs package(s) with dependencies. - **-d** ** Lists package dependencies - **-D** ** List all dependencies for package(s) - **-j** ** List all reverse dependencies for the package (packages that depend on it). - - - + # EXAMPLES # ENVIRONMENT VARIABLES @@ -33,10 +30,10 @@ Arguments for apkg are as follows: - *APKG_ROOT* Overrides default root location (/), where sw is installed - *APKG_CONF* Overrides default location for the configuration file apkg.conf. The default is under /etc on an installed alice linux system. - *APKG_NOPROMPT* If set, it enabled non-interactive use by disabling user confirmation prompt. -- *APKG_REPO* Double-quoted, space-seperated list for the local directories that contain build templates. +- *APKG_REPO* Double-quoted, space-separated list for the local directories that contain build templates. - *APKG_PACKAGE_DIR* Directory where the compiled packages will reside. - *APKG_SOURCE_DIR* Directory that will hold the downloaded sources. -- *APKG_WORK_DIR* Directory where the actuall building proccess will take place. This happens in subdirectories which are cleaned after completion. +- *APKG_WORK_DIR* Directory where the actual building process will take place. This happens in subdirectories which are cleaned after completion. - *APKG_LOG* If set, it enables the creation of a log for the program output. **Note:** Usually, APKG_REPO, APKG_PACKAGE_DIR, APKG_SOURCE_DIR and APKG_WORK_DIR are declared in the apkg.conf configuration file. For more information, please see apkg.conf(5). @@ -52,5 +49,6 @@ build and installed packages. For example, one can look to the alice linux repos **apkg** is in a working stage but also under heavy development. Please report and bugs/issues in the project issue tracker: https://codeberg.org/emmett1/autils/issues # AUTHORS + emmett1 Author of the program and creator of alice linux. mobinmob Author of the man page. diff --git a/doc/revdep.md b/doc/revdep.md index be1bdf2..44eef7a 100644 --- a/doc/revdep.md +++ b/doc/revdep.md @@ -1,22 +1,23 @@ # NAME **revdep** - utility to discover and rebuild reverse deps - # DESCRIPTION + **revdep** is a utility inspired by the gentoo program revdep-rebuild. It is written in posix shell and -it can discover programs that need to be rebuild after library upgrades or are missing libraries. +it can discover programs that need to be rebuilt after library upgrades or are missing libraries. It should probably run after any big upgrade, especially those that feature lib version bumps. - # OPTIONS + - **-h** Show program help. -- **-v** Be verbose in the operation. -- +- **-v** Verbose output of the operation. + # BUGS **apkg** is in a working stage but also under heavy development. Please report and bugs/issues in the project issue tracker: https://codeberg.org/emmett1/autils/issues # AUTHORS + emmett1 Author of the program and creator of alice linux. mobinmob Author of the man page. -- cgit v1.2.3