Skip to content

Commit

Permalink
Automatic Man Page Update
Browse files Browse the repository at this point in the history
Signed-off-by: distrobox-docs-bot <[email protected]>
  • Loading branch information
actions-user authored and distrobox-docs-bot committed Feb 3, 2024
1 parent a672b48 commit ac7d6d6
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 8 deletions.
2 changes: 1 addition & 1 deletion man/man1/distrobox-assemble.1
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ specified using the \f[V]--file\f[R] flag.
.nf
\f[C]
--file: path to the distrobox manifest/ini file
--name/-n: run against a single entry in the manifest/ini file
--name/-n: run against a single entry in the manifest/ini file
--replace/-R: replace already existing distroboxes with matching names
--dry-run/-d: only print the container manager command generated
--verbose/-v: show more verbosity
Expand Down
1 change: 1 addition & 0 deletions man/man1/distrobox-create.1
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ usb devices and graphical apps (X11/Wayland), and audio.
--pre-init-hooks: additional commands to execute prior to container initialization
--init/-I: use init system (like systemd) inside the container.
this will make host\[aq]s processes not visible from within the container. (assumes --unshare-process)
may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/useful_tips.md#using-init-system-inside-a-distrobox
--nvidia: try to integrate host\[aq]s nVidia drivers in the guest
--unshare-devsys: do not share host devices and sysfs dirs from host
--unshare-ipc: do not share ipc namespace with host
Expand Down
2 changes: 1 addition & 1 deletion man/man1/distrobox-enter.1
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ specify the \[en]headless mode to disable tty and interactivity.
.nf
\f[C]
--name/-n: name for the distrobox default: my-distrobox
--/-e: end arguments execute the rest as command to execute at login default: bash -l
--/-e: end arguments execute the rest as command to execute at login default: su ${USER}
--no-tty/-T: do not instantiate a tty
--no-workdir/-nw: always start the container from container\[aq]s home directory
--additional-flags/-a: additional flags to pass to the container manager command
Expand Down
2 changes: 1 addition & 1 deletion man/man1/distrobox-ephemeral.1
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ destroyed when the command is terminated.
specify it through the DBX_SUDO_PROGRAM env variable, or \[aq]distrobox_sudo_program\[aq] config variable)
--verbose/-v: show more verbosity
--help/-h: show this message
--/-e: end arguments execute the rest as command to execute at login default: bash -l
--/-e: end arguments execute the rest as command to execute at login default: su ${USER}
--version/-V: show version
\f[R]
.fi
Expand Down
1 change: 1 addition & 0 deletions man/man1/distrobox-export.1
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ will automatically be launched from the container it is exported from.
Defaults to (on \[rs]$container_name)
--export-path/-ep: path where to export the binary
--extra-flags/-ef: extra flags to add to the command
--enter-flags/-nf: flags to add to distrobox-enter
--sudo/-S: specify if the exported item should be run as sudo
--help/-h: show this message
--verbose/-v: show more verbosity
Expand Down
2 changes: 1 addition & 1 deletion man/man1/distrobox-upgrade.1
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ perform an upgrade using the container\[cq]s package manager.
\f[C]
--help/-h: show this message
--all/-a: perform for all distroboxes
--running: perform only on running distroboxes
--running: perform only for running distroboxes
--root/-r: launch podman/docker/lilipod with root privileges. Note that if you need root this is the preferred
way over \[dq]sudo distrobox\[dq] (note: if using a program other than \[aq]sudo\[aq] for root privileges is necessary,
specify it through the DBX_SUDO_PROGRAM env variable, or \[aq]distrobox_sudo_program\[aq] config variable)
Expand Down
10 changes: 6 additions & 4 deletions man/man1/distrobox.1
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ specified using the \f[V]--file\f[R] flag.
.nf
\f[C]
--file: path to the distrobox manifest/ini file
--name/-n: run against a single entry in the manifest/ini file
--name/-n: run against a single entry in the manifest/ini file
--replace/-R: replace already existing distroboxes with matching names
--dry-run/-d: only print the container manager command generated
--verbose/-v: show more verbosity
Expand Down Expand Up @@ -830,6 +830,7 @@ usb devices and graphical apps (X11/Wayland), and audio.
--pre-init-hooks: additional commands to execute prior to container initialization
--init/-I: use init system (like systemd) inside the container.
this will make host\[aq]s processes not visible from within the container. (assumes --unshare-process)
may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/useful_tips.md#using-init-system-inside-a-distrobox
--nvidia: try to integrate host\[aq]s nVidia drivers in the guest
--unshare-devsys: do not share host devices and sysfs dirs from host
--unshare-ipc: do not share ipc namespace with host
Expand Down Expand Up @@ -1205,7 +1206,7 @@ specify the \[en]headless mode to disable tty and interactivity.
.nf
\f[C]
--name/-n: name for the distrobox default: my-distrobox
--/-e: end arguments execute the rest as command to execute at login default: bash -l
--/-e: end arguments execute the rest as command to execute at login default: su ${USER}
--no-tty/-T: do not instantiate a tty
--no-workdir/-nw: always start the container from container\[aq]s home directory
--additional-flags/-a: additional flags to pass to the container manager command
Expand Down Expand Up @@ -1355,7 +1356,7 @@ destroyed when the command is terminated.
specify it through the DBX_SUDO_PROGRAM env variable, or \[aq]distrobox_sudo_program\[aq] config variable)
--verbose/-v: show more verbosity
--help/-h: show this message
--/-e: end arguments execute the rest as command to execute at login default: bash -l
--/-e: end arguments execute the rest as command to execute at login default: su ${USER}
--version/-V: show version
\f[R]
.fi
Expand Down Expand Up @@ -1434,6 +1435,7 @@ will automatically be launched from the container it is exported from.
Defaults to (on \[rs]$container_name)
--export-path/-ep: path where to export the binary
--extra-flags/-ef: extra flags to add to the command
--enter-flags/-nf: flags to add to distrobox-enter
--sudo/-S: specify if the exported item should be run as sudo
--help/-h: show this message
--verbose/-v: show more verbosity
Expand Down Expand Up @@ -2077,7 +2079,7 @@ perform an upgrade using the container\[cq]s package manager.
\f[C]
--help/-h: show this message
--all/-a: perform for all distroboxes
--running: perform only on running distroboxes
--running: perform only for running distroboxes
--root/-r: launch podman/docker/lilipod with root privileges. Note that if you need root this is the preferred
way over \[dq]sudo distrobox\[dq] (note: if using a program other than \[aq]sudo\[aq] for root privileges is necessary,
specify it through the DBX_SUDO_PROGRAM env variable, or \[aq]distrobox_sudo_program\[aq] config variable)
Expand Down

0 comments on commit ac7d6d6

Please sign in to comment.