diff options
Diffstat (limited to 'man/man8/apkg.8')
| -rw-r--r-- | man/man8/apkg.8 | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/man/man8/apkg.8 b/man/man8/apkg.8 new file mode 100644 index 0000000..2727207 --- /dev/null +++ b/man/man8/apkg.8 @@ -0,0 +1,181 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.TH "" "8" "" +.SH NAME +.SH DESCRIPTION +.LP +\fBapkg\fR is the package build tool and package installer, along with \fBspm\fR 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. +.SH OPTIONS +.LP +Arguments for apkg are as follows: +.IP "\(bu" 3 +\fB-h\fR Print help. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-i\fR \fI\fR Install package(s) without taking dependencies into account. Building will fail if the dependencies are not present in the system. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-I\fR \fI\fR Install package(s) with dependencies. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-d\fR \fI\fR List only direct package dependencies +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-D\fR \fI\fR List all dependencies for package(s) +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-j\fR \fI\fR List all reverse dependencies for the package (packages that depend on it). +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-u\fR \fI\fR Upgrade package(s) +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-r\fR \fI\fR Remove package(s) +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-t\fR \fI\fR Run scripts for package(s) that update cache or dbs (mime, font cache e.t.c) +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-U\fR Update system +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-f\fR Force rebuild a package. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-o\fR \fI\fR Only download source for package(s), do not build and install +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-p\fR \fI\fR Print full path to the package build template directory +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-s\fR \fI\fR Search for packages +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fB-g\fR \fI\fR Update or generate checksum(s) for the package source files. +.SH ENVIRONMENT VARIABLES +.IP "\(bu" 3 +\f(CRAPKG_ROOT\fR Overrides default root location (/), where sw is installed +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\f(CRAPKG_CONF\fR Overrides default location for the configuration file apkg.conf. The default is under /etc on an installed alice linux system. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\f(CRAPKG_NOPROMPT\fR If set, it enabled non-interactive use by disabling user confirmation prompt. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\f(CRAPKG_REPO\fR Double-quoted, space-separated list for the local directories that contain build templates. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\f(CRAPKG_PACKAGE_DIR\fR Directory where the compiled packages will reside. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\f(CRAPKG_SOURCE_DIR\fR Directory that will hold the downloaded sources. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\f(CRAPKG_WORK_DIR\fR Directory where the actual building process will take place. This happens in subdirectories which are cleaned after completion. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\f(CRAPKG_LOG\fR If set, it enables the creation of a log for the program output. +.LP +\fBNote:\fR Usually, APKG\fIREPO, APKG\fRPACKAGE\fIDIR, APKG\fRSOURCE\fIDIR and APKG\fRWORK_DIR are declared in the apkg.conf configuration file. For more information, please see apkg.conf(5). +.SH FILES +.IP "\(bu" 3 +\fBapkg.conf(5)\fR is the default configuration file, it resides by default under /etc. +.if n \ +.sp -1 +.if t \ +.sp -0.25v +.IP "\(bu" 3 +\fBabuild\fR 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 \c +.UR https://codeberg.org/emmett1/alicelinux/src/branch/main/repos +.UE +.SH EXAMPLES +.LP +\f(CRapkg -i linux\fR - Install the \fIlinux\fR package +.PP +\f(CRapkg -f jupp\fR - Force rebuild the \fIjupp\fR package. If someone tries with just \f(CR-i\fR, \f(CRapkg\fR will produce the following message +if the package is already installed: \f(CR[...] Package 'jupp' already installed.\fR +.PP +\f(CRapkg -s icon\fR - Search for packages names that contain \(lqicon\(rq, it will produce a list with one +package per line. +.SH AUTHORS +.LP +emmett1 \c +.MT emmett1.2miligrams@protonmail.com +.ME +Author of the program and creator of alice linux. +.PP +mobinmob \c +.MT mobinmob@disroot.org +.ME +Author of the man page. +.SH REPORTING BUGS +.LP +\fBapkg\fR is in a working stage but also under heavy development. Please report and bugs/issues in the project issue tracker: \c +.UR https://codeberg.org/emmett1/autils/issues +.UE |