31 changes: 19 additions & 12 deletions docs/usage/distrobox-list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
<!-- markdownlint-disable MD010 -->
# List containers
<!-- markdownlint-disable MD010 MD036 -->
# NAME

distrobox list
distrobox-list

# DESCRIPTION

distrobox-list lists available distroboxes. It detects them and lists them separately
from the rest of normal podman or docker containers.

Usage:
# SYNOPSIS

**distrobox list**

--help/-h: show this message
--root/-r: launch podman/docker with root privileges. Note that if you need root this is the preferred
way over "sudo distrobox"
--size/-s: show also container size
--verbose/-v: show more verbosity
--version/-V: show version

# EXAMPLES

distrobox-list

Expand All @@ -16,13 +32,4 @@ Supported environment variables:

DBX_CONTAINER_MANAGER

Options:

--help/-h: show this message
--root/-r: launch podman/docker with root privileges. Note that if you need root this is the preferred
way over "sudo distrobox"
--size/-s: show also container size
--verbose/-v: show more verbosity
--version/-V: show version

![image](https://user-images.githubusercontent.com/598882/147831082-24b5bc2e-b47e-49ac-9b1a-a209478c9705.png)
33 changes: 20 additions & 13 deletions docs/usage/distrobox-rm.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
<!-- markdownlint-disable MD010 -->
# Remove containers
<!-- markdownlint-disable MD010 MD036 -->
# NAME

distrobox rm
distrobox-rm

# DESCRIPTION

distrobox-rm delete one of the available distroboxes.

Usage:
# SYNOPSIS

**distrobox rm**

--name/-n: name for the distrobox
--force/-f: force deletion
--root/-r: launch podman/docker with root privileges. Note that if you need root this is the preferred
way over "sudo distrobox"
--help/-h: show this message
--verbose/-v: show more verbosity
--version/-V: show version

# EXAMPLES

distrobox-rm --name container-name [--force]
distrobox-rm container-name [-f]
Expand All @@ -17,13 +34,3 @@ Supported environment variables:
DBX_CONTAINER_MANAGER
DBX_CONTAINER_NAME
DBX_NON_INTERACTIVE

Options:

--name/-n: name for the distrobox
--force/-f: force deletion
--root/-r: launch podman/docker with root privileges. Note that if you need root this is the preferred
way over "sudo distrobox"
--help/-h: show this message
--verbose/-v: show more verbosity
--version/-V: show version
33 changes: 20 additions & 13 deletions docs/usage/distrobox-stop.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,29 @@
<!-- markdownlint-disable MD010 -->
# Stop containers
<!-- markdownlint-disable MD010 MD036 -->
# NAME

distrobox stop
distrobox-stop

# DESCRIPTION

distrobox-stop stop a running distrobox.

Distroboxes are left running, even after exiting out of them, so that
subsequent enters are really quick. This is how they can be stopped.

Usage:
# SYNOPSIS

**distrobox stop**

--name/-n: name for the distrobox
--yes/-Y: non-interactive, stop without asking
--help/-h: show this message
--root/-r: launch podman/docker with root privileges. Note that if you need root this is the preferred
way over "sudo distrobox"
--verbose/-v: show more verbosity
--version/-V: show version

# EXAMPLES

distrobox-stop --name container-name
distrobox-stop container-name
Expand All @@ -20,13 +37,3 @@ Supported environment variables:
DBX_CONTAINER_MANAGER
DBX_CONTAINER_NAME
DBX_NON_INTERACTIVE

Options:

--name/-n: name for the distrobox
--yes/-Y: non-interactive, stop without asking
--help/-h: show this message
--root/-r: launch podman/docker with root privileges. Note that if you need root this is the preferred
way over "sudo distrobox"
--verbose/-v: show more verbosity
--version/-V: show version
1 change: 1 addition & 0 deletions docs/usage/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@
- [distrobox-stop](distrobox-stop.md)
- [Inside the distrobox](#inside-the-distrobox)
- [distrobox-export](distrobox-export.md)
- [distrobox-host-exec](distrobox-host-exec.md)
- [distrobox-init](distrobox-init.md)
1 change: 1 addition & 0 deletions man/gen-man
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ END="$(grep -n -B1 "# Containers Distros" "$(dirname "${0}")/../docs/compatibili

sed -e "${START},${END}d" "$(dirname "${0}")/../docs/compatibility.md" > "${compatibility_file}"
sed -e "1,${HEAD}d" -i "${compatibility_file}"
sed -i "s/^#.*/\U&/g" "${compatibility_file}"

pandoc --standalone \
--metadata title="DISTROBOX" \
Expand Down