mirror of
https://github.com/tldr-pages/tldr.git
synced 2024-10-28 19:19:44 +01:00
distrobox-*: update and add pages
✨ feat: distrobox documentation ✨ distrobox: add page ✨ distrobox: doc for each subcommand 💄 distrobox: beautify docs 💄 distrobox: beautify docs ✏ fix: more command info fix: minor cleanup Co-authored-by: Emily Grace Seville <EmilySeville7cfg@gmail.com> 🩹 fix: minor cleanup Co-authored-by: Emily Grace Seville <EmilySeville7cfg@gmail.com> 🩹 fix: minor cleanup Co-authored-by: Emily Grace Seville <EmilySeville7cfg@gmail.com>
This commit is contained in:
parent
fd1f3808bd
commit
67757373a1
9 changed files with 120 additions and 13 deletions
|
@ -1,13 +1,13 @@
|
|||
# distrobox-create
|
||||
|
||||
> Create Distrobox containers with an input name and image.
|
||||
> Create a distrobox container. More about distrobox: `tldr distrobox`.
|
||||
> The created container will be tightly integrated with the host, allowing sharing of the HOME directory of the user, external storage, external usb devices and graphical apps (X11/Wayland), and audio.
|
||||
> More information: <https://distrobox.privatedns.org>.
|
||||
> More information: <https://github.com/89luca89/distrobox/blob/main/docs/usage/distrobox-create.md>.
|
||||
|
||||
- Create a distrobox using the Alpine image:
|
||||
- Create a distrobox using the Ubuntu Linux image:
|
||||
|
||||
`distrobox-create {{container_name}} --image alpine`
|
||||
`distrobox-create {{container_name}} --image {{ubuntu:latest}}`
|
||||
|
||||
- Clone a distrobox:
|
||||
- Clone a distrobox container:
|
||||
|
||||
`distrobox-create --clone {{container_name}} {{cloned_container_name}}`
|
||||
|
|
|
@ -1,8 +1,12 @@
|
|||
# distrobox-enter
|
||||
|
||||
> Run a command in a Distrobox container.
|
||||
> Enter a distrobox container. More about distrobox: `tldr distrobox`.
|
||||
> Default command executed is your SHELL, but you can specify different shells or entire commands to execute. If used inside a script, an application, or a service, you can specify the --headless mode to disable tty and interactivity.
|
||||
> More information: <https://distrobox.privatedns.org>.
|
||||
> More information: <https://github.com/89luca89/distrobox/blob/main/docs/usage/distrobox-enter.md>.
|
||||
|
||||
- Enter a distrobox:
|
||||
|
||||
`distrobox-enter {{container-name}}`
|
||||
|
||||
- Enter a distrobox and run `sh -l`:
|
||||
|
||||
|
|
25
pages/linux/distrobox-export.md
Normal file
25
pages/linux/distrobox-export.md
Normal file
|
@ -0,0 +1,25 @@
|
|||
# distrobox-export
|
||||
|
||||
> Export app/service/binary from container to host OS.
|
||||
> Subcommand of `distrobox`. More about distrobox: `tldr distrobox`.
|
||||
> More information: <https://github.com/89luca89/distrobox/blob/main/docs/usage/distrobox-export.md>.
|
||||
|
||||
- Export an app (eg: gedit) from the container to the host (will show up in your host system's application list):
|
||||
|
||||
`distrobox-export --app {{gedit}} --extra-flags "--foreground"`
|
||||
|
||||
- Export a binary from the container to the host:
|
||||
|
||||
`distrobox-export --bin {{path/to/binary}} --export-path {{path/to/binary_on_host}}`
|
||||
|
||||
- Export a binary (eg: ranger) from the container to the host:
|
||||
|
||||
`distrobox-export --bin {{/usr/bin/ranger}} --export-path {{$HOME/.local/bin}}`
|
||||
|
||||
- Export a service (eg: syncthing) from container to the host (`--sudo` will run the service as root inside the container):
|
||||
|
||||
`distrobox-export --service {{syncthing}} --extra-flags "--allow-newer-config" --sudo`
|
||||
|
||||
- Unexport/delete an exported app (eg: gedit):
|
||||
|
||||
`distrobox-export --app {{gedit}} --delete`
|
13
pages/linux/distrobox-host-exec.md
Normal file
13
pages/linux/distrobox-host-exec.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
# distrobox-host-exec
|
||||
|
||||
> Execute a command on host while inside a distrobox container.
|
||||
> Subcommand of `distrobox`. More about distrobox: `tldr distrobox`.
|
||||
> More information: <https://github.com/89luca89/distrobox/blob/main/docs/usage/distrobox-host-exec.md>.
|
||||
|
||||
- Execute command on the host system, while inside of a container:
|
||||
|
||||
`distrobox-host-exec "{{command}}"`
|
||||
|
||||
- Execute `ls` command on the host system, while inside of a container:
|
||||
|
||||
`distrobox-host-exec ls`
|
|
@ -1,7 +1,8 @@
|
|||
# distrobox-list
|
||||
|
||||
> List available Distrobox containers. It detects them and lists them separately from the rest of normal podman or Docker containers.
|
||||
> More information: <https://distrobox.privatedns.org>.
|
||||
> List all distrobox containers. More about distrobox: `tldr distrobox`.
|
||||
> It detects them and lists them separately from the rest of normal podman or Docker containers.
|
||||
> More information: <https://github.com/89luca89/distrobox/blob/main/docs/usage/distrobox-list.md>.
|
||||
|
||||
- List all distrobox containers:
|
||||
|
||||
|
@ -9,4 +10,4 @@
|
|||
|
||||
- List all distrobox containers with verbose information:
|
||||
|
||||
`distrobox-list -v`
|
||||
`distrobox-list --verbose`
|
||||
|
|
|
@ -1,9 +1,10 @@
|
|||
# distrobox-rm
|
||||
|
||||
> Delete Distrobox containers.
|
||||
> More information: <https://distrobox.privatedns.org>.
|
||||
> Remove a distrobox container.
|
||||
> Subcommand of `distrobox`. More about distrobox: `tldr distrobox`.
|
||||
> More information: <https://github.com/89luca89/distrobox/blob/main/docs/usage/distrobox-rm.md>.
|
||||
|
||||
- Remove a distrobox:
|
||||
- Remove a distrobox (remember to stop container before removing it):
|
||||
|
||||
`distrobox-rm {{container_name}}`
|
||||
|
||||
|
|
9
pages/linux/distrobox-stop.md
Normal file
9
pages/linux/distrobox-stop.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
# distrobox-stop
|
||||
|
||||
> Stop a distrobox container.
|
||||
> Subcommand of `distrobox`. More about distrobox: `tldr distrobox`.
|
||||
> More information: <https://github.com/89luca89/distrobox/blob/main/docs/usage/distrobox-stop.md>.
|
||||
|
||||
- Stop a distrobox container:
|
||||
|
||||
`distrobox-stop {{container-name}}`
|
17
pages/linux/distrobox-upgrade.md
Normal file
17
pages/linux/distrobox-upgrade.md
Normal file
|
@ -0,0 +1,17 @@
|
|||
# distrobox-upgrade
|
||||
|
||||
> Upgrade a distrobox container.
|
||||
> Subcommand of `distrobox`. More about distrobox: `tldr distrobox`.
|
||||
> More information: <https://github.com/89luca89/distrobox/blob/main/docs/usage/distrobox-upgrade.md>.
|
||||
|
||||
- Upgrade a container using the container's package manager:
|
||||
|
||||
`distrobox-upgrade {{container_name}}`
|
||||
|
||||
- Upgrade all containers using the containers' package managers:
|
||||
|
||||
`distrobox-upgrade --all`
|
||||
|
||||
- Upgrade specific containers via containers' package managers:
|
||||
|
||||
`distrobox-upgrade {{container1 container2 ...}}`
|
37
pages/linux/distrobox.md
Normal file
37
pages/linux/distrobox.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
# distrobox
|
||||
|
||||
> Use any Linux distribution inside your terminal by running it as a container. Install & use packages inside it while tightly integrating with host OS, sharing storage, HOME directory with GUI & audio capabilities.
|
||||
> You can install any software inside it. Eg: installing a `.deb` package inside an ubuntu container running on an Arch Linux host system. Packages inside container can access host's files.
|
||||
> More information: <https://github.com/89luca89/distrobox>.
|
||||
|
||||
- Show tldr page for distrobox-create (creating containers):
|
||||
|
||||
`tldr distrobox-create`
|
||||
|
||||
- Show tldr page for distrobox-list (list container info):
|
||||
|
||||
`tldr distrobox-list`
|
||||
|
||||
- Show tldr page for distrobox-enter (enter inside containers):
|
||||
|
||||
`tldr distrobox-enter`
|
||||
|
||||
- Show tldr page for distrobox-host-exec (Execute command on host while inside a container):
|
||||
|
||||
`tldr distrobox-host-exec`
|
||||
|
||||
- Show tldr page for distrobox-export (Export app/service/binary from container to host):
|
||||
|
||||
`tldr distrobox-export`
|
||||
|
||||
- Show tldr page for distrobox-upgrade (upgrade containers):
|
||||
|
||||
`tldr distrobox-upgrade`
|
||||
|
||||
- Show tldr page for distrobox-stop (stop containers):
|
||||
|
||||
`tldr distrobox-stop`
|
||||
|
||||
- Show tldr page for distrobox-rm (remove containers):
|
||||
|
||||
`tldr distrobox-rm`
|
Loading…
Reference in a new issue