toolbox/doc/toolbox-enter.1.md at 816a7cab9e2f02f2eb828062be54ffef2e3666dc

Debarshi Ray 936a157117 doc, test/system: Fix the titles of the manuals

Currently, the titles of the manuals are rendered with a pair of empty
parentheses and no section title:
  toolbox(1)()                                              toolbox(1)()

  NAME
         toolbox - Tool for containerized command line environments...

However, they should be:
  toolbox(1)             General Commands Manual              toolbox(1)

  NAME
         toolbox - Tool for containerized command line environments...

This is because the troff generated by go-md2man from Markdown has a
faulty invocation of the .TH macro [1]:
  .nh
  .TH toolbox(1)
  .SH NAME
  .PP
  toolbox - Tool for containerized command line environments on Linux

It should be:
  .nh
  .TH toolbox 1
  .SH NAME
  .PP
  toolbox - Tool for containerized command line environments on Linux

Original patch from Andrew Denton for Podman [2].

[1] https://www.gnu.org/software/groff/manual/groff.html

[2] Podman commit 63c779a857b55b00
    https://github.com/containers/podman/pull/15621

https://github.com/containers/toolbox/pull/1210

2023-01-12 18:45:00 +01:00

1.8 KiB

Raw Blame History

% toolbox-enter 1

NAME

toolbox-enter - Enter a toolbox container for interactive use

SYNOPSIS

toolbox enter [--distro DISTRO | -d DISTRO] [--release RELEASE | -r RELEASE] [CONTAINER]

DESCRIPTION

Spawns an interactive shell inside a toolbox container that was created using the toolbox create command. It tries to spawn the user's default shell, but if it's not available inside the container then it falls back to /bin/bash.

When invoked without any options, toolbox enter will try to enter the default toolbox container for the host, or if there's only one container available then it will use it. On Fedora, the default container is known as fedora-toolbox-N, where N is the release of the host. If there aren't any containers, toolbox enter will offer to create the default one for you.

A specific container can be selected using the CONTAINER argument.

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

OPTIONS

The following options are understood:

--distro DISTRO, -d DISTRO

Enter a toolbox container for a different operating system DISTRO than the host. Has to be coupled with --release unless the selected DISTRO matches the host.

--release RELEASE, -r RELEASE

Enter a toolbox container for a different operating system RELEASE than the host.

EXAMPLES

Enter a toolbox container using the default image matching the host OS

$ toolbox enter

Enter a toolbox container using the default image for Fedora 36

$ toolbox enter --distro fedora --release f36

Enter a custom toolbox container using a custom image

$ toolbox enter foo

1.8 KiB Raw Blame History