aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoremmett1 <emmett1.2miligrams@protonmail.com>2024-08-24 17:50:46 +0800
committeremmett1 <emmett1.2miligrams@protonmail.com>2024-08-24 17:50:46 +0800
commit4bf6e463a6f22e1a58150bf2bb9000af0f5bab55 (patch)
tree8eef31513194c10d20a76266bf8343bb85d48409
parentb78ca5ec23fe5c4ac8ff4c0db82fa2ce40c73266 (diff)
downloadautils-4bf6e463a6f22e1a58150bf2bb9000af0f5bab55.tar.gz
autils-4bf6e463a6f22e1a58150bf2bb9000af0f5bab55.zip
added pregenerated man-pages
-rw-r--r--doc/man/man5/apkg.conf.582
-rw-r--r--doc/man/man8/apkg.8173
-rw-r--r--doc/man/man8/revdep.826
3 files changed, 281 insertions, 0 deletions
diff --git a/doc/man/man5/apkg.conf.5 b/doc/man/man5/apkg.conf.5
new file mode 100644
index 0000000..3d739d6
--- /dev/null
+++ b/doc/man/man5/apkg.conf.5
@@ -0,0 +1,82 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.TH "" "5" ""
+.SH
+.LP
+\fBapkg.conf\fR is the configuration file for the \fBapkg\fR package manager for the alice linux distribution.
+It resides by default under \f(CR/etc\fR in an alice linux installation.
+The contents are sourced by the \fBapkg\fR program and are in the posix shell \f(CRkey=\(dqvalue\(dq\fR format.
+.SH
+CONFIGURATION KEYS
+.IP "\(bu" 3
+\f(CRAPKG_NOPROMPT\fR If set, it enables non-interactive use by disabling user confirmation prompt.
+.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.
+.if n \
+.sp -1
+.if t \
+.sp -0.25v
+.IP "\(bu" 3
+\f(CRexport CFLAGS=\(dq<cflags>\(dq\fR Default are \fI-O3 -march=x86-64 -pipe\fR
+.if n \
+.sp -1
+.if t \
+.sp -0.25v
+.IP "\(bu" 3
+\f(CRexport CXXFLAGS=\(dq$CFLAGS\(dq\fR
+.if n \
+.sp -1
+.if t \
+.sp -0.25v
+.IP "\(bu" 3
+\f(CRexport NINJAJOBS=\(dq<-x>\(dq\fR 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.
+.if n \
+.sp -1
+.if t \
+.sp -0.25v
+.IP "\(bu" 3
+\f(CRexport MAKEFLAGS=\(dq-jx\(dq\fR Replace with the number of jobs the make build system with use.
+.LP
+EXAMPLES
+.LP
+.EX
+### example of a valid apkg.conf ###
+export CFLAGS=\(dq-O3 -march=x86-64 -pipe\(dq
+export CXXFLAGS=\(dq$CFLAGS\(dq
+export MAKEFLAGS=\(dq-j12\(dq
+export NINJAJOBS=\(dq12\(dq
+APKG_REPO=\(dq/var/lib/alicelinux/repos/core /var/lib/alicelinux/repos/extra /var/lib/alicelinux/repos/xorg /var/lib/alicelinux/repos/wayland\(dq
+APKG_PACKAGE_DIR=/var/cache/pkg
+APKG_SOURCE_DIR=/var/cache/src
+APKG_WORK_DIR=/var/cache/work
+.EE
+.SH
+AUTHORS
+.LP
+emmett1 \fIemmett1.2miligrams@protonmail.com\fR Author of the program and creator of alice linux.
+mobinmob \fImobinmob@disroot.org\fR 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: \fIhttps://codeberg.org/emmett1/autils/issues\fR
diff --git a/doc/man/man8/apkg.8 b/doc/man/man8/apkg.8
new file mode 100644
index 0000000..8733be6
--- /dev/null
+++ b/doc/man/man8/apkg.8
@@ -0,0 +1,173 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.TH "" "8" ""
+.SH
+.LP
+\fBapkg\fR [-i] [-I] [-d] [-D] [-j] [-u] [-r] [-t] [-U ] [-f] [-o] [-p] [-s] [-h] [\fIpkg(s)\fR]
+.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
+.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 \fIhttps://codeberg.org/emmett1/alicelinux/src/branch/main/repos\fR
+.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 \fIemmett1.2miligrams@protonmail.com\fR Author of the program and creator of alice linux.
+mobinmob \fImobinmob@disroot.org\fR 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: \fIhttps://codeberg.org/emmett1/autils/issues\fR
diff --git a/doc/man/man8/revdep.8 b/doc/man/man8/revdep.8
new file mode 100644
index 0000000..c5e765e
--- /dev/null
+++ b/doc/man/man8/revdep.8
@@ -0,0 +1,26 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.TH "" "8" ""
+.SH
+.LP
+\fBrevdep\fR is a utility inspired by the gentoo program revdep-rebuild. It is written in posix shell and
+it can discover programs that need to be rebuilt after library upgrades or are missing libraries.
+It should probably run after any big upgrade, especially those that feature lib version bumps.
+.SH
+OPTIONS
+.IP "\(bu" 3
+\fB-h\fR Show program help.
+.if n \
+.sp -1
+.if t \
+.sp -0.25v
+.IP "\(bu" 3
+\fB-v\fR Verbose output of the operation.
+.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: \fIhttps://codeberg.org/emmett1/autils/issues\fR
+.SH
+AUTHORS
+.LP
+emmett1 \fIemmett1.2miligrams@protonmail.com\fR Author of the program and creator of alice linux.
+mobinmob \fImobinmob@disroot.org\fR Author of the man page.