Skip to content

Commit

Permalink
docs: update usages for all
Browse files Browse the repository at this point in the history
Signed-off-by: Luca Di Maio <[email protected]>
  • Loading branch information
89luca89 committed Feb 3, 2024
1 parent 54cfcbe commit a672b48
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/usage/distrobox-assemble.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The manifest file by default is `./distrobox.ini`, but can be specified using th
**distrobox assemble**

--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 docs/usage/distrobox-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ 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'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'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 docs/usage/distrobox-enter.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If using it inside a script, an application, or a service, you can specify the
**distrobox enter**

--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's home directory
--additional-flags/-a: additional flags to pass to the container manager command
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/distrobox-ephemeral.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ when the command is terminated.
specify it through the DBX_SUDO_PROGRAM env variable, or 'distrobox_sudo_program' 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

# EXAMPLES
Expand Down
1 change: 1 addition & 0 deletions docs/usage/distrobox-export.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ automatically be launched from the container it is exported from.
Defaults to (on \$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 docs/usage/distrobox-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ an upgrade using the container's package manager.

--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 "sudo distrobox" (note: if using a program other than 'sudo' for root privileges is necessary,
specify it through the DBX_SUDO_PROGRAM env variable, or 'distrobox_sudo_program' config variable)
Expand Down

0 comments on commit a672b48

Please sign in to comment.