From 7702b15c4ccd839932ad1378cacb7deec67c7d0c Mon Sep 17 00:00:00 2001 From: emmett1 Date: Sun, 22 Dec 2024 03:19:44 +0800 Subject: updated some docs --- man/apkg.conf.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 man/apkg.conf.md (limited to 'man/apkg.conf.md') diff --git a/man/apkg.conf.md b/man/apkg.conf.md new file mode 100644 index 0000000..d4aa590 --- /dev/null +++ b/man/apkg.conf.md @@ -0,0 +1,45 @@ +# 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=""` Default 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 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 Author of the program and creator of alice linux. + +mobinmob 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 -- cgit v1.2.3