From 7702b15c4ccd839932ad1378cacb7deec67c7d0c Mon Sep 17 00:00:00 2001 From: emmett1 Date: Sun, 22 Dec 2024 03:19:44 +0800 Subject: updated some docs --- doc/apkg.md | 72 ------------------------------------------------------------- 1 file changed, 72 deletions(-) delete mode 100644 doc/apkg.md (limited to 'doc/apkg.md') diff --git a/doc/apkg.md b/doc/apkg.md deleted file mode 100644 index a692d1e..0000000 --- a/doc/apkg.md +++ /dev/null @@ -1,72 +0,0 @@ -# NAME - -**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] [-g] [-h] [*pkg(s)*] - -# DESCRIPTION - -**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** Print help. -- **-i** ** Install package(s) without taking dependencies into account. Building will fail if the dependencies are not present in the system. -- **-I** ** Install package(s) with dependencies. -- **-d** ** List only direct package dependencies -- **-D** ** List all dependencies for package(s) -- **-j** ** List all reverse dependencies for the package (packages that depend on it). -- **-u** ** Upgrade package(s) -- **-r** ** Remove package(s) -- **-t** ** Run scripts for package(s) that update cache or dbs (mime, font cache e.t.c) -- **-U** Update system -- **-f** Force rebuild a package. -- **-o** ** Only download source for package(s), do not build and install -- **-p** ** Print full path to the package build template directory -- **-s** ** Search for packages -- **-g** ** Update or generate checksum(s) for the package source files. - -# ENVIRONMENT VARIABLES - -- `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-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 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). - -# FILES - -- **apkg.conf(5)** is the default configuration file, it resides by default under /etc. -- **abuild** is the name of the package templates that apkg uses, along with relevant files in order to -build and installed packages. For example, one can look to the alice linux repos, under https://codeberg.org/emmett1/alicelinux/src/branch/main/repos - -# EXAMPLES - -`apkg -i linux` - Install the *linux* package - -`apkg -f jupp` - Force rebuild the *jupp* package. If someone tries with just `-i`, `apkg` will produce the following message -if the package is already installed: `[...] Package 'jupp' already installed.` - -`apkg -s icon` - Search for packages names that contain "icon", it will produce a list with one -package per line. - -# 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