From 73697a40604100b6c2c5e54fddbc3a65d49f9bab Mon Sep 17 00:00:00 2001 From: Xavier Moffett Date: Sat, 14 Sep 2024 21:13:37 -0400 Subject: [PATCH] Update doucmentation to reflect e4b8a85ccd33b06f8f90b5ae23e5cda8de4ab684 --- dist/man/pacwrap.1 | 29 ++++++++++++++++++++++++++++- dist/man/pacwrap.yml.2 | 7 ++++++- docs/config.md | 6 +++++- docs/manual.md | 23 ++++++++++++++++++++++- 4 files changed, 61 insertions(+), 4 deletions(-) diff --git a/dist/man/pacwrap.1 b/dist/man/pacwrap.1 index 2ed1a33..011814f 100644 --- a/dist/man/pacwrap.1 +++ b/dist/man/pacwrap.1 @@ -1,5 +1,5 @@ .nh -.TH pacwrap 1 "30/04/2024" "pacwrap version_string_placeholder" "User Manual" +.TH pacwrap 1 "14/09/2024" "pacwrap version_string_placeholder" "User Manual" .SH NAME\fR @@ -191,6 +191,15 @@ Transact on resident containers with a database-only transaction. \fB--noconfirm\fR Override confirmation prompts and confirm all operations. +.TP +\fB--disable-sandbox\fR +Instruct libalpm to disable its own sandbox, utilizing landlock and seccomp, in order to mitigate potential +issues with kernel compatibillity. + +.TP +\fB--debug\fR +Use this option when reporting bugs. + .SS EXAMPLES\fR .TP @@ -258,6 +267,15 @@ Transact on resident containers with a database-only transaction. \fB--noconfirm\fR Override confirmation prompts and confirm all operations. +.TP +\fB--disable-sandbox\fR +Instruct libalpm to disable its own sandbox, utilizing landlock and seccomp, in order to mitigate potential +issues with kernel compatibillity. + +.TP +\fB--debug\fR +Use this option when reporting bugs. + .SS EXAMPLES\fR .TP @@ -313,6 +331,15 @@ pathway to allow composition of dormant, uninitialized container configurations. \fB--noconfirm\fR Override confirmation prompts and confirm all operations. +.TP +\fB--disable-sandbox\fR +Instruct libalpm to disable its own sandbox, utilizing landlock and seccomp, in order to mitigate potential +issues with kernel compatibillity. + +.TP +\fB--debug\fR +Use this option when reporting bugs. + .SS EXAMPLES\fR .TP diff --git a/dist/man/pacwrap.yml.2 b/dist/man/pacwrap.yml.2 index e4713ef..87660d7 100644 --- a/dist/man/pacwrap.yml.2 +++ b/dist/man/pacwrap.yml.2 @@ -1,5 +1,5 @@ .nh -.TH pacwrap.yml 2 "21/04/2024" "pacwrap version_string_placeholder" "Pacwrap Configuration Directives" +.TH pacwrap.yml 2 "14/09/2024" "pacwrap version_string_placeholder" "Pacwrap Configuration Directives" .SH NAME\fR @@ -128,6 +128,11 @@ a \fBbool\fR. Instructs \fBlibalpm\fR(3) to parallelise the download queue with a maximum queue amount. Specify an \fBinteger\fR to declare a maximum value. +.TP +\fBdisable_sandbox\fR: false +Instructs \fBlibalpm\fR(3) to disable the landlock and seccomp sandbox for downloads. Specify a +\fBbool\fR to declare a maximum value. + .SH SEE ALSO\fR \fBpacman.conf\fR(5), \fBlibalpm\fR(3) diff --git a/docs/config.md b/docs/config.md index f92237c..82ce522 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,6 +1,6 @@ # Pacwrap Configuration Directives -This document was generated by the pacwrap binary with version 0.8.1-78bbcbe-RELEASE (21/04/2024) of the program. +This document was generated by the pacwrap binary with version 0.8.4-43de5c7-RELEASE (14/09/2024) of the program. ## NAME #### **pacwrap.yml** - pacwrap configuration file. @@ -100,6 +100,10 @@ a **bool**. Instructs **libalpm**(3) to parallelise the download queue with a maximum queue amount. Specify an **integer** to declare a maximum value. +#### **disable_sandbox**: false +Instructs **libalpm**(3) to disable the landlock and seccomp sandbox for downloads. Specify a +**bool** to declare a maximum value. + ## SEE ALSO **pacman.conf**(5), **libalpm**(3) diff --git a/docs/manual.md b/docs/manual.md index 76b2a9a..e08556f 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -1,6 +1,6 @@ # Pacwrap User Manual -This document was generated by the pacwrap binary with version 0.8.1-c243d52-RELEASE (30/04/2024) of the program. +This document was generated by the pacwrap binary with version 0.8.4-43de5c7-RELEASE (14/09/2024) of the program. ## NAME pacwrap @@ -150,6 +150,13 @@ Transact on resident containers with a database-only transaction. #### **--noconfirm** Override confirmation prompts and confirm all operations. +#### **--disable-sandbox** +Instruct libalpm to disable its own sandbox, utilizing landlock and seccomp, in order to mitigate potential +issues with kernel compatibillity. + +#### **--debug** +Use this option when reporting bugs. + ### **EXAMPLES** #### `$ pacwrap init --base --target base` Synchronize remotes and create a base-type container named `base` with no additional packages. @@ -201,6 +208,13 @@ Transact on resident containers with a database-only transaction. #### **--noconfirm** Override confirmation prompts and confirm all operations. +#### **--disable-sandbox** +Instruct libalpm to disable its own sandbox, utilizing landlock and seccomp, in order to mitigate potential +issues with kernel compatibillity. + +#### **--debug** +Use this option when reporting bugs. + ### **EXAMPLES** #### `$ pacwrap -Rt firefox firefox` Remove the target package firefox from target container firefox. @@ -244,6 +258,13 @@ pathway to allow composition of dormant, uninitialized container configurations. #### **--noconfirm** Override confirmation prompts and confirm all operations. +#### **--disable-sandbox** +Instruct libalpm to disable its own sandbox, utilizing landlock and seccomp, in order to mitigate potential +issues with kernel compatibillity. + +#### **--debug** +Use this option when reporting bugs. + ### **EXAMPLES** #### `$ pacwrap compose -rt element element.yml` Reinitialize an existing container named element with its configuration derived