summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile1
-rw-r--r--doc/apk-audit.8.scd55
2 files changed, 56 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 262e717..6dae470 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -6,6 +6,7 @@ $(obj)/%.8: $(src)/%.8.scd
docs: $(obj)/apk.8 \
$(obj)/apk-add.8 \
+ $(obj)/apk-audit.8 \
$(obj)/apk-cache.8 \
$(obj)/apk-del.8 \
$(obj)/apk-dot.8 \
diff --git a/doc/apk-audit.8.scd b/doc/apk-audit.8.scd
new file mode 100644
index 0000000..ad4bc60
--- /dev/null
+++ b/doc/apk-audit.8.scd
@@ -0,0 +1,55 @@
+apk-audit(8)
+
+# NAME
+
+apk audit - audit directories for changes
+
+# SYNOPSIS
+
+*apk audit* [<_options_>...] _directories_...
+
+# DESCRIPTION
+
+*apk audit* audits the specified directories for changes from the package
+database. By default, the output format is one file per line, for each affected
+file. A character is printed indicating the change detected, followed by a
+space, then the affected path. The changes detected are:
+
+|[ A
+:< File added
+| d
+: Directory added
+| D
+: Directory added (with non-listed files/subdirs)
+| M
+: File metadata changed (uid, gid, or mode)
+| m
+: Directory metadata changed
+| U
+: File contents modified
+| X
+: File deleted
+| x
+: xattrs changed
+
+# OPTIONS
+
+*--check-permissions*
+ In addition to checking file contents, check the uid, gid, and file
+ mode as well.
+
+*--packages*
+ Instead of printing each modified file, print the names and versions of
+ the packages which own the affected files.
+
+*--system*
+ List all modified configuration files (in protected_paths.d) that need
+ to be backed up.
+
+*-r, --recursive*
+ Descend into directories and audit them as well.
+
+# AUTHORS
+
+Natanael Copa <ncopa@alpinelinux.org>++
+Timo Teräs <_timo.teras@iki.fi_>