aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoremmett1 <emmett1.2miligrams@protonmail.com>2024-08-30 11:22:51 +0000
committeremmett1 <emmett1.2miligrams@protonmail.com>2024-08-30 11:22:51 +0000
commit1301d84c0cf6c991998288e65e904973700c04b0 (patch)
tree47c3233c4b603d66333e0d9ae016b1c908eb31fc
parent99b72ff92222d754759428fd618e0e3a5d3f7cca (diff)
parent477ff8abdd05a12ea19c0dd9d5bf70a0426a699a (diff)
downloadautils-1301d84c0cf6c991998288e65e904973700c04b0.tar.gz
autils-1301d84c0cf6c991998288e65e904973700c04b0.zip
Merge pull request '/doc: add info for the addition of checksums, also:' (#6) from mobinmob/autils:doc_fixes into main
Reviewed-on: https://codeberg.org/emmett1/autils/pulls/6 Reviewed-by: emmett1 <emmett1.2miligrams@protonmail.com>
-rw-r--r--doc/apkg.conf.md3
-rw-r--r--doc/apkg.md4
-rw-r--r--doc/man/man5/apkg.conf.51
-rw-r--r--doc/man/man8/apkg.89
-rw-r--r--doc/man/man8/revdep.86
-rw-r--r--doc/revdep.md6
6 files changed, 26 insertions, 3 deletions
diff --git a/doc/apkg.conf.md b/doc/apkg.conf.md
index b3b4647..d4aa590 100644
--- a/doc/apkg.conf.md
+++ b/doc/apkg.conf.md
@@ -37,8 +37,9 @@ APKG_WORK_DIR=/var/cache/work
# AUTHORS
emmett1 <emmett1.2miligrams@protonmail.com> Author of the program and creator of alice linux.
+
mobinmob <mobinmob@disroot.org> 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 \ No newline at end of file
+**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
diff --git a/doc/apkg.md b/doc/apkg.md
index cc844c3..a692d1e 100644
--- a/doc/apkg.md
+++ b/doc/apkg.md
@@ -4,7 +4,7 @@
# SYNOPSIS
-**apkg** [-i] [-I] [-d] [-D] [-j] [-u] [-r] [-t] [-U ] [-f] [-o] [-p] [-s] [-h] [*pkg(s)*]
+**apkg** [-i] [-I] [-d] [-D] [-j] [-u] [-r] [-t] [-U ] [-f] [-o] [-p] [-s] [-g] [-h] [*pkg(s)*]
# DESCRIPTION
@@ -30,6 +30,7 @@ Arguments for apkg are as follows:
- **-o** *<pkg(s)>* Only download source for package(s), do not build and install
- **-p** *<pkg(s)>* Print full path to the package build template directory
- **-s** *<pattern>* Search for packages
+- **-g** *<pkg>* Update or generate checksum(s) for the package source files.
# ENVIRONMENT VARIABLES
@@ -63,6 +64,7 @@ package per line.
# AUTHORS
emmett1 <emmett1.2miligrams@protonmail.com> Author of the program and creator of alice linux.
+
mobinmob <mobinmob@disroot.org> Author of the man page.
# REPORTING BUGS
diff --git a/doc/man/man5/apkg.conf.5 b/doc/man/man5/apkg.conf.5
index 3d739d6..8047562 100644
--- a/doc/man/man5/apkg.conf.5
+++ b/doc/man/man5/apkg.conf.5
@@ -75,6 +75,7 @@ APKG_WORK_DIR=/var/cache/work
AUTHORS
.LP
emmett1 \fIemmett1.2miligrams@protonmail.com\fR Author of the program and creator of alice linux.
+.PP
mobinmob \fImobinmob@disroot.org\fR Author of the man page.
.SH
REPORTING BUGS
diff --git a/doc/man/man8/apkg.8 b/doc/man/man8/apkg.8
index 8733be6..5b46f82 100644
--- a/doc/man/man8/apkg.8
+++ b/doc/man/man8/apkg.8
@@ -2,7 +2,7 @@
.TH "" "8" ""
.SH
.LP
-\fBapkg\fR [-i] [-I] [-d] [-D] [-j] [-u] [-r] [-t] [-U ] [-f] [-o] [-p] [-s] [-h] [\fIpkg(s)\fR]
+\fBapkg\fR [-i] [-I] [-d] [-D] [-j] [-u] [-r] [-t] [-U ] [-f] [-o] [-p] [-s] [-g] [-h] [\fIpkg(s)\fR]
.SH
DESCRIPTION
.LP
@@ -93,6 +93,12 @@ Arguments for apkg are as follows:
.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
@@ -166,6 +172,7 @@ package per line.
AUTHORS
.LP
emmett1 \fIemmett1.2miligrams@protonmail.com\fR Author of the program and creator of alice linux.
+.PP
mobinmob \fImobinmob@disroot.org\fR Author of the man page.
.SH
REPORTING BUGS
diff --git a/doc/man/man8/revdep.8 b/doc/man/man8/revdep.8
index c5e765e..b8dc1f1 100644
--- a/doc/man/man8/revdep.8
+++ b/doc/man/man8/revdep.8
@@ -16,6 +16,11 @@ OPTIONS
.IP "\(bu" 3
\fB-v\fR Verbose output of the operation.
.SH
+NOTE
+.LP
+\fBrevdep\fR does not automatically rebuild broken packages or their dependencies. You need to
+use apkg for these operations.
+.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
@@ -23,4 +28,5 @@ REPORTING BUGS
AUTHORS
.LP
emmett1 \fIemmett1.2miligrams@protonmail.com\fR Author of the program and creator of alice linux.
+.PP
mobinmob \fImobinmob@disroot.org\fR Author of the man page.
diff --git a/doc/revdep.md b/doc/revdep.md
index fd50104..6f23ee3 100644
--- a/doc/revdep.md
+++ b/doc/revdep.md
@@ -13,6 +13,11 @@ It should probably run after any big upgrade, especially those that feature lib
- **-h** Show program help.
- **-v** Verbose output of the operation.
+# NOTE
+
+**revdep** does not automatically rebuild broken packages or their dependencies. You need to
+use apkg for these operations.
+
# 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
@@ -20,4 +25,5 @@ It should probably run after any big upgrade, especially those that feature lib
# AUTHORS
emmett1 <emmett1.2miligrams@protonmail.com> Author of the program and creator of alice linux.
+
mobinmob <mobinmob@disroot.org> Author of the man page.