diff options
Diffstat (limited to 'doc/apkg.conf.md')
| -rw-r--r-- | doc/apkg.conf.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/apkg.conf.md b/doc/apkg.conf.md new file mode 100644 index 0000000..b3b4647 --- /dev/null +++ b/doc/apkg.conf.md @@ -0,0 +1,44 @@ +# NAME + +**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 contents are sourced by the **apkg** program and are in the posix shell `key="value"` format. + +# CONFIGURATION KEYS + +- `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 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="<cflags>"` Default <cflags> are *-O3 -march=x86-64 -pipe* +- `export CXXFLAGS="$CFLAGS"` +- `export NINJAJOBS="<-x>"` Replace <-x> with the number of jobs the ninja build system with use. Without this it will use the maximum amount of threads the processor suports. +- `export MAKEFLAGS="-jx"` Replace <x> with the number of jobs the make build system with use. + +EXAMPLES + +``` +### example of a valid apkg.conf ### +export CFLAGS="-O3 -march=x86-64 -pipe" +export CXXFLAGS="$CFLAGS" +export MAKEFLAGS="-j12" +export NINJAJOBS="12" +APKG_REPO="/var/lib/alicelinux/repos/core /var/lib/alicelinux/repos/extra /var/lib/alicelinux/repos/xorg /var/lib/alicelinux/repos/wayland" +APKG_PACKAGE_DIR=/var/cache/pkg +APKG_SOURCE_DIR=/var/cache/src +APKG_WORK_DIR=/var/cache/work +``` + +# AUTHORS + +emmett1 <emmett1.2miligrams@protonmail.com> Author of the program and creator of alice linux. +mobinmob <mobinmob@disroot.org> Author of the man page. + +# REPORTING 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
\ No newline at end of file |