From 0bb6c1c8e02eddeff40b25e39f232db1f71ca37d Mon Sep 17 00:00:00 2001 From: distrobox-docs-bot Date: Fri, 28 Jun 2024 15:37:46 +0000 Subject: [PATCH] Automatic Man Page Update Signed-off-by: distrobox-docs-bot --- man/man1/distrobox-assemble.1 | 110 ++++++++++++++++++++++++---------- man/man1/distrobox.1 | 110 ++++++++++++++++++++++++---------- 2 files changed, 160 insertions(+), 60 deletions(-) diff --git a/man/man1/distrobox-assemble.1 b/man/man1/distrobox-assemble.1 index cca1bbeee2..66191d9c70 100644 --- a/man/man1/distrobox-assemble.1 +++ b/man/man1/distrobox-assemble.1 @@ -154,144 +154,194 @@ actually running them. .PP This is a list of available options with the corresponding type: .PP +Types legend: +.IP \[bu] 2 +bool: true or false +.IP \[bu] 2 +string: a single string, for example +\f[V]home=\[dq]/home/luca-linux/dbox\[dq]\f[R] +.IP \[bu] 2 +string_list: multiple strings, for example +\f[V]additional_packages=\[dq]htop vim git\[dq]\f[R]. +Note that \f[V]string_list\f[R] can be declared multiple times to be +compounded: +.IP +.nf +\f[C] + [ubuntu] + image=ubuntu:latest + additional_packages=\[dq]git vim tmux nodejs\[dq] + additional_packages=\[dq]htop iftop iotop\[dq] + additional_packages=\[dq]zsh fish\[dq] +\f[R] +.fi +.PP .TS tab(@); -l l. +lw(23.3n) lw(23.3n) lw(23.3n). T{ Flag Name T}@T{ Type +T}@T{ T} _ T{ additional_flags T}@T{ -string +string_list +T}@T{ +Additional flags to pass to the container manager T} T{ additional_packages T}@T{ -string +string_list +T}@T{ +Additional packages to install inside the container T} T{ home T}@T{ string +T}@T{ +Which home directory should the container use T} T{ image T}@T{ string +T}@T{ +Which image should the container use, look here for a list T} T{ init_hooks T}@T{ -string +string_list +T}@T{ +Commands to run inside the container, after the packages setup T} T{ pre_init_hooks T}@T{ -string +string_list +T}@T{ +Commands to run inside the container, before the packages setup T} T{ volume T}@T{ -string +string_list +T}@T{ +Additional volumes to mount inside the containers T} T{ exported_apps T}@T{ -string +string_list +T}@T{ +App names or desktopfile paths to export T} T{ exported_bins T}@T{ -string +string_list +T}@T{ +Binaries to export T} T{ exported_bins_path T}@T{ string +T}@T{ +Optional path where to export binaries (default: $HOME/.local/bin) T} T{ entry T}@T{ bool +T}@T{ +Generate an entry for the container in the app list (default: false) T} T{ start_now T}@T{ bool +T}@T{ +Start the container immediately (default: false) T} T{ init T}@T{ bool +T}@T{ +Specify if this is an initful container (default: false) T} T{ nvidia T}@T{ bool +T}@T{ +Specify if you want to enable NVidia drivers integration (default: +false) T} T{ pull T}@T{ bool +T}@T{ +Specify if you want to pull the image every time (default: false) T} T{ root T}@T{ bool +T}@T{ +Specify if the container is rootful (default: false) T} T{ unshare_ipc T}@T{ bool +T}@T{ +Specify if the container should unshare the ipc namespace (default: +false) T} T{ unshare_netns T}@T{ bool +T}@T{ +Specify if the container should unshare the network namespace (default: +false) T} T{ unshare_process T}@T{ bool +T}@T{ +Specify if the container should unshare the process (pid) namespace +(default: false) T} T{ unshare_devsys T}@T{ bool +T}@T{ +Specify if the container should unshare /dev (default: false) T} T{ unshare_all T}@T{ bool +T}@T{ +Specify if the container should unshare all the previous options +(default: false) T} .TE .PP -boolean options default to false if not specified. -string options can be broken in multiple declarations additively in -order to improve readability of the file: -.IP -.nf -\f[C] -[ubuntu] -image=ubuntu:latest -additional_packages=\[dq]git vim tmux nodejs\[dq] -additional_packages=\[dq]htop iftop iotop\[dq] -additional_packages=\[dq]zsh fish\[dq] -\f[R] -.fi -.PP -Be aware that if you\[cq]re doing lines with spaces, you need to quote -them. -If you\[cq]re doing multiple hooks (init or pre_init) in multiple lines, -end the line with a semicolon (;) in order to execute them one after the -other. -.PP -For an explanation of each of the option in the list, take a look at the -distrobox create usage, each option corresponds to one of the +For further explanation of each of the option in the list, take a look +at the distrobox create usage, each option corresponds to one of the \f[V]create\f[R] flags. .PP \f[B]Advanced example\f[R] diff --git a/man/man1/distrobox.1 b/man/man1/distrobox.1 index 923a9ceb33..6b81bed1e5 100644 --- a/man/man1/distrobox.1 +++ b/man/man1/distrobox.1 @@ -154,144 +154,194 @@ actually running them. .PP This is a list of available options with the corresponding type: .PP +Types legend: +.IP \[bu] 2 +bool: true or false +.IP \[bu] 2 +string: a single string, for example +\f[V]home=\[dq]/home/luca-linux/dbox\[dq]\f[R] +.IP \[bu] 2 +string_list: multiple strings, for example +\f[V]additional_packages=\[dq]htop vim git\[dq]\f[R]. +Note that \f[V]string_list\f[R] can be declared multiple times to be +compounded: +.IP +.nf +\f[C] + [ubuntu] + image=ubuntu:latest + additional_packages=\[dq]git vim tmux nodejs\[dq] + additional_packages=\[dq]htop iftop iotop\[dq] + additional_packages=\[dq]zsh fish\[dq] +\f[R] +.fi +.PP .TS tab(@); -l l. +lw(23.3n) lw(23.3n) lw(23.3n). T{ Flag Name T}@T{ Type +T}@T{ T} _ T{ additional_flags T}@T{ -string +string_list +T}@T{ +Additional flags to pass to the container manager T} T{ additional_packages T}@T{ -string +string_list +T}@T{ +Additional packages to install inside the container T} T{ home T}@T{ string +T}@T{ +Which home directory should the container use T} T{ image T}@T{ string +T}@T{ +Which image should the container use, look here for a list T} T{ init_hooks T}@T{ -string +string_list +T}@T{ +Commands to run inside the container, after the packages setup T} T{ pre_init_hooks T}@T{ -string +string_list +T}@T{ +Commands to run inside the container, before the packages setup T} T{ volume T}@T{ -string +string_list +T}@T{ +Additional volumes to mount inside the containers T} T{ exported_apps T}@T{ -string +string_list +T}@T{ +App names or desktopfile paths to export T} T{ exported_bins T}@T{ -string +string_list +T}@T{ +Binaries to export T} T{ exported_bins_path T}@T{ string +T}@T{ +Optional path where to export binaries (default: $HOME/.local/bin) T} T{ entry T}@T{ bool +T}@T{ +Generate an entry for the container in the app list (default: false) T} T{ start_now T}@T{ bool +T}@T{ +Start the container immediately (default: false) T} T{ init T}@T{ bool +T}@T{ +Specify if this is an initful container (default: false) T} T{ nvidia T}@T{ bool +T}@T{ +Specify if you want to enable NVidia drivers integration (default: +false) T} T{ pull T}@T{ bool +T}@T{ +Specify if you want to pull the image every time (default: false) T} T{ root T}@T{ bool +T}@T{ +Specify if the container is rootful (default: false) T} T{ unshare_ipc T}@T{ bool +T}@T{ +Specify if the container should unshare the ipc namespace (default: +false) T} T{ unshare_netns T}@T{ bool +T}@T{ +Specify if the container should unshare the network namespace (default: +false) T} T{ unshare_process T}@T{ bool +T}@T{ +Specify if the container should unshare the process (pid) namespace +(default: false) T} T{ unshare_devsys T}@T{ bool +T}@T{ +Specify if the container should unshare /dev (default: false) T} T{ unshare_all T}@T{ bool +T}@T{ +Specify if the container should unshare all the previous options +(default: false) T} .TE .PP -boolean options default to false if not specified. -string options can be broken in multiple declarations additively in -order to improve readability of the file: -.IP -.nf -\f[C] -[ubuntu] -image=ubuntu:latest -additional_packages=\[dq]git vim tmux nodejs\[dq] -additional_packages=\[dq]htop iftop iotop\[dq] -additional_packages=\[dq]zsh fish\[dq] -\f[R] -.fi -.PP -Be aware that if you\[cq]re doing lines with spaces, you need to quote -them. -If you\[cq]re doing multiple hooks (init or pre_init) in multiple lines, -end the line with a semicolon (;) in order to execute them one after the -other. -.PP -For an explanation of each of the option in the list, take a look at the -distrobox create usage, each option corresponds to one of the +For further explanation of each of the option in the list, take a look +at the distrobox create usage, each option corresponds to one of the \f[V]create\f[R] flags. .PP \f[B]Advanced example\f[R]