Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
The 'reset' command has been dropped (command 'podman system reset'
should have the same effect now), so the man page has also been dropped.

The whole documentation was slightly updated to match the current
behaviour of Toolbox. I'm not entirely satsified with the state our
documentation is in, so some more changes will certainly follow.
  • Loading branch information
HarryMichal committed Mar 3, 2020
1 parent 76246ee commit 10327e0
Show file tree
Hide file tree
Showing 9 changed files with 35 additions and 90 deletions.
31 changes: 4 additions & 27 deletions doc/toolbox-create.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@
toolbox\-create - Create a new toolbox container

## SYNOPSIS
**toolbox create** [*--candidate-registry*]
[*--container NAME* | *-c NAME*]
[*--image NAME* | *-i NAME*]
[*--release RELEASE* | *-r RELEASE*]
**toolbox create** [*options*] *CONTAINER*

## DESCRIPTION

Expand All @@ -16,31 +13,16 @@ to interact with the container at any point.

A toolbox container is an OCI container created from an OCI image. On Fedora
the base image is known as `fedora-toolbox`. If the image is not present
locally, then it is pulled from `registry.fedoraproject.org`. The base image is
locally customized for the current user to create a second image, from which
the container is finally created.
locally, then it is pulled from `registry.fedoraproject.org`.

Toolbox containers and images are tagged with the version of the OS that
corresponds to the content inside them. The user-specific images and the
toolbox containers are prefixed with the name of the base image and suffixed
with the current user name.
toolbox containers are prefixed with the name of the base image.

## OPTIONS ##

The following options are understood:

**--candidate-registry**

Pull the base image from `candidate-registry.fedoraproject.org`. This is
useful for testing newly built images before they have moved to the stable
registry at `registry.fedoraproject.org`.

**--container** NAME, **-c** NAME

Assign a different NAME to the toolbox container. This is useful for creating
multiple toolbox containers from the same base image, or for entirely
customized containers from custom-built base images.

**--image** NAME, **-i** NAME

Change the NAME of the base image used to create the toolbox container. This
Expand Down Expand Up @@ -68,14 +50,9 @@ $ toolbox create --release f30
### Create a custom toolbox container from a custom image

```
$ toolbox create --container foo --image bar
$ toolbox create foo --image bar
```

### Create a toolbox using images from the unstable candidate registry

```
$ toolbox create --candidate-registry
```

## SEE ALSO

Expand Down
15 changes: 4 additions & 11 deletions doc/toolbox-enter.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
toolbox\-enter - Enter a toolbox container for interactive use

## SYNOPSIS
**toolbox enter** [*--container NAME* | *-c NAME*]
[*--release RELEASE* | *-r RELEASE*]
**toolbox enter** [*options*] *CONTAINER*

## DESCRIPTION

Expand All @@ -20,18 +19,12 @@ analogous to a `podman start` followed by a `podman exec`.

On Fedora the toolbox containers are tagged with the version of the OS that
corresponds to the content inside them. Their names are prefixed with the name
of the base image and suffixed with the current user name.
of the base image.

## OPTIONS ##

The following options are understood:

**--container** NAME, **-c** NAME

Enter a toolbox container with the given NAME. This is useful when there are
multiple toolbox containers created from the same base image, or entirely
customized containers created from custom-built base images.

**--release** RELEASE, **-r** RELEASE

Enter a toolbox container for a different operating system RELEASE than the
Expand All @@ -51,10 +44,10 @@ $ toolbox enter
$ toolbox enter --release f30
```

### Enter a custom toolbox container using a custom image
### Enter a custom toolbox container using a custom name

```
$ toolbox enter --container foo
$ toolbox enter foo
```

## SEE ALSO
Expand Down
13 changes: 5 additions & 8 deletions doc/toolbox-help.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,20 @@ toolbox\-help - Display help information about Toolbox

## DESCRIPTION

When no COMMAND is specified, the `toolbox(1)` manual is shown. If a COMMAND
is specified, a manual page for that command is brought up.
When no COMMAND is specified, the basic usage screen is shown. If a COMMAND
is specified, a usage screen for that command is shown.

Note that `toolbox --help ...` is identical to `toolbox help ...` because the
former is internally converted to the latter.

This page can be displayed with `toolbox help help` or `toolbox help --help`.
Note that `toolbox --help ...` is identical to `toolbox help ...`.

## EXAMPLES

### Show the toolbox manual
### Show the basic usage screen of Toolbox

```
$ toolbox help
```

### Show the manual for the create command
### Show the usage screen of the create command

```
$ toolbox help create
Expand Down
2 changes: 1 addition & 1 deletion doc/toolbox-list.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
toolbox\-list - List existing toolbox containers and images

## SYNOPSIS
**toolbox list** [*--containers* | *-c*] [*--images* | *-i*]
**toolbox list** [*options*]

## DESCRIPTION

Expand Down
26 changes: 0 additions & 26 deletions doc/toolbox-reset.1.md

This file was deleted.

6 changes: 3 additions & 3 deletions doc/toolbox-rm.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
toolbox\-rm - Remove one or more toolbox containers

## SYNOPSIS
**toolbox rm** [*--all*] [*--force*] [*CONTAINER*...]
**toolbox rm** [*options*] [*CONTAINER*...]

## DESCRIPTION

Expand All @@ -29,10 +29,10 @@ Force the removal of running and paused toolbox containers.

## EXAMPLES

### Remove a toolbox container named `fedora-toolbox-gegl:30`
### Remove a toolbox container named `fedora-toolbox-gegl-30`

```
$ toolbox rm fedora-toolbox-gegl:30
$ toolbox rm fedora-toolbox-gegl-30
```

### Remove all toolbox containers, but not those that are running or paused
Expand Down
2 changes: 1 addition & 1 deletion doc/toolbox-rmi.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
toolbox\-rmi - Remove one or more toolbox images

## SYNOPSIS
**toolbox rmi** [*--all*] [*--force*] [*IMAGE*...]
**toolbox rmi** [*options*] [*IMAGE*...]

## DESCRIPTION

Expand Down
19 changes: 10 additions & 9 deletions doc/toolbox-run.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,31 @@
toolbox\-run - Run a command in an existing toolbox container

## SYNOPSIS
**toolbox run** [*--container NAME* | *-c NAME*]
[*--release RELEASE* | *-r RELEASE*] [*COMMAND*]
**toolbox run** [*options*] *CONTAINER* [*COMMAND* [*args* ...]]

## DESCRIPTION

Runs a command inside an existing toolbox container. The container should have
been created using the `toolbox create` command.

If the **--release | -r** option is specified, then the CONTAINER does not have
to be specified.

A toolbox container is an OCI container. Therefore, `toolbox run` is analogous
to a `podman start` followed by a `podman exec`.

On Fedora the toolbox containers are tagged with the version of the OS that
corresponds to the content inside them. Their names are prefixed with the name
of the base image and suffixed with the current user name.
of the base image.

## OPTIONS ##

The following options are understood:

**--container** NAME, **-c** NAME
**--default**, **-d**

Run command inside a toolbox container with the given NAME. This is useful
when there are multiple toolbox containers created from the same base image,
or entirely customized containers created from custom-built base images.
Run command inside a toolbox container using the default image matching the
host OS.

**--release** RELEASE, **-r** RELEASE

Expand All @@ -39,7 +40,7 @@ RELEASE than the host.
### Run ls inside a toolbox container using the default image matching the host OS

```
$ toolbox run ls -la
$ toolbox run -d ls -la
```

### Run emacs inside a toolbox container using the default image for Fedora 30
Expand All @@ -51,7 +52,7 @@ $ toolbox run --release f30 emacs
### Run uptime inside a custom toolbox container using a custom image

```
$ toolbox run --container foo uptime
$ toolbox run foo uptime
```

## SEE ALSO
Expand Down
11 changes: 7 additions & 4 deletions doc/toolbox.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
toolbox - Unprivileged development environment

## SYNOPSIS
**toolbox** [*--verbose* | *-v*] *COMMAND* [*ARGS*]
**toolbox** [options] *COMMAND*

## DESCRIPTION

Expand Down Expand Up @@ -40,10 +40,13 @@ Automatically answer yes for all questions.

Print a synopsis of this manual and exit.

**--verbose, -v**
**--log-level**

Print debug information including standard error stream of internal commands.
Use `-vv` for more detail.
Log messages above specified level: trace, debug, info, warn, error, fatal or panic (default "warn").

**--log-podman**

Show the log output of Podman. The log level is handled by the log-level option.

## COMMANDS

Expand Down

0 comments on commit 10327e0

Please sign in to comment.