From 017ec72df257c209d2dcb2e7671eba898c4e37cb Mon Sep 17 00:00:00 2001 From: mobinmob Date: Fri, 16 Aug 2024 21:47:59 +0300 Subject: /docs : initial documentation commit. --- doc/apkg.conf.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 doc/apkg.conf.md (limited to 'doc/apkg.conf.md') diff --git a/doc/apkg.conf.md b/doc/apkg.conf.md new file mode 100644 index 0000000..83f4277 --- /dev/null +++ b/doc/apkg.conf.md @@ -0,0 +1,30 @@ +# 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 contends 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_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_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. + +# 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