Skip to content
Permalink
Browse files

man: fix man-pages

The man-pages are using pre-formatted section to display the options for
all commands. The result on my system never looked correct:

OPTIONS
       --bundle value, -b value  path to the root [...]
          --console-socket value    path to an AF_UNIX [...]

The first line was always indented less than the other lines.

This commit makes the option block a pre-formatted block (as intended???) by
using 4 spaces instead of 3 spaces.

In addition the man-pages did not specify their name and section
correctly. This adds something like '% runc-run "8"' to all man-pages to
have correct title 'runc-run(8)' instead of 'NAME()' and it also adds
the section to the title: 'System Manager's Manual'.

This also fixes the use of '>' and '<' at multiple places. The markdown
source files were using "<container-id>" and similar which was (most of
the time) rendered as '""'. On some systems it was rendered correctly.

Signed-off-by: Adrian Reber <areber@redhat.com>
  • Loading branch information...
adrianreber committed Aug 6, 2019
1 parent 2e94378 commit 1712af0e80eecf17be40d0417bc5f22491d4c54b
@@ -1,28 +1,30 @@
% runc-checkpoint "8"

# NAME
runc checkpoint - checkpoint a running container

# SYNOPSIS
runc checkpoint [command options] <container-id>
runc checkpoint [command options] `<container-id>`

Where "<container-id>" is the name for the instance of the container to be
Where "`<container-id>`" is the name for the instance of the container to be
checkpointed.

# DESCRIPTION
The checkpoint command saves the state of the container instance.

# OPTIONS
--image-path value path for saving criu image files
--work-path value path for saving work files and logs
--parent-path value path for previous criu image files in pre-dump
--leave-running leave the process running after checkpointing
--tcp-established allow open tcp connections
--ext-unix-sk allow external unix sockets
--shell-job allow shell jobs
--lazy-pages use userfaultfd to lazily restore memory pages
--status-fd value criu writes \0 to this FD once lazy-pages is ready
--page-server value ADDRESS:PORT of the page server
--file-locks handle file locks, for safety
--pre-dump dump container's memory information only, leave the container running after this
--manage-cgroups-mode value cgroups mode: 'soft' (default), 'full' and 'strict'
--empty-ns value create a namespace, but don't restore its properties
--auto-dedup enable auto deduplication of memory images
--image-path value path for saving criu image files
--work-path value path for saving work files and logs
--parent-path value path for previous criu image files in pre-dump
--leave-running leave the process running after checkpointing
--tcp-established allow open tcp connections
--ext-unix-sk allow external unix sockets
--shell-job allow shell jobs
--lazy-pages use userfaultfd to lazily restore memory pages
--status-fd value criu writes \0 to this FD once lazy-pages is ready
--page-server value ADDRESS:PORT of the page server
--file-locks handle file locks, for safety
--pre-dump dump container's memory information only, leave the container running after this
--manage-cgroups-mode value cgroups mode: 'soft' (default), 'full' and 'strict'
--empty-ns value create a namespace, but don't restore its properties
--auto-dedup enable auto deduplication of memory images
@@ -1,10 +1,12 @@
% runc-create "8"

# NAME
runc create - create a container

# SYNOPSIS
runc create [command options] <container-id>
runc create [command options] `<container-id>`

Where "<container-id>" is your name for the instance of the container that you
Where "`<container-id>`" is your name for the instance of the container that you
are starting. The name you provide for the container instance must be unique on
your host.

@@ -19,9 +21,9 @@ command(s) that get executed on start, edit the args parameter of the spec. See
"runc spec --help" for more explanation.

# OPTIONS
--bundle value, -b value path to the root of the bundle directory, defaults to the current directory
--console-socket value path to an AF_UNIX socket which will receive a file descriptor referencing the master end of the console's pseudoterminal
--pid-file value specify the file to write the process id to
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
--no-new-keyring do not create a new session keyring for the container. This will cause the container to inherit the calling processes session key
--preserve-fds value Pass N additional file descriptors to the container (stdio + $LISTEN_FDS + N in total) (default: 0)
--bundle value, -b value path to the root of the bundle directory, defaults to the current directory
--console-socket value path to an AF_UNIX socket which will receive a file descriptor referencing the master end of the console's pseudoterminal
--pid-file value specify the file to write the process id to
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
--no-new-keyring do not create a new session keyring for the container. This will cause the container to inherit the calling processes session key
--preserve-fds value Pass N additional file descriptors to the container (stdio + $LISTEN_FDS + N in total) (default: 0)
@@ -1,13 +1,15 @@
% runc-delete "8"

# NAME
runc delete - delete any resources held by the container often used with detached container

# SYNOPSIS
runc delete [command options] <container-id>
runc delete [command options] `<container-id>`

Where "<container-id>" is the name for the instance of the container.
Where "`<container-id>`" is the name for the instance of the container.

# OPTIONS
--force, -f Forcibly deletes the container if it is still running (uses SIGKILL)
--force, -f Forcibly deletes the container if it is still running (uses SIGKILL)

# EXAMPLE
For example, if the container id is "ubuntu01" and runc list currently shows the
@@ -1,15 +1,17 @@
% runc-events "8"

# NAME
runc events - display container events such as OOM notifications, cpu, memory, and IO usage statistics

# SYNOPSIS
runc events [command options] <container-id>
runc events [command options] `<container-id>`

Where "<container-id>" is the name for the instance of the container.
Where "`<container-id>`" is the name for the instance of the container.

# DESCRIPTION
The events command displays information about the container. By default the
information is displayed once every 5 seconds.

# OPTIONS
--interval value set the stats collection interval (default: 5s)
--stats display the container's stats then exit
--interval value set the stats collection interval (default: 5s)
--stats display the container's stats then exit
@@ -1,11 +1,13 @@
% runc-exec "8"

# NAME
runc exec - execute new process inside the container

# SYNOPSIS
runc exec [command options] <container-id> -- <container command> [args...]
runc exec [command options] `<container-id>` -- `<container command>` [args...]

Where "<container-id>" is the name for the instance of the container and
"<container command>" is the command to be executed in the container.
Where "`<container-id>`" is the name for the instance of the container and
"`<container command>`" is the command to be executed in the container.

# EXAMPLE
For example, if the container is configured to run the linux ps command the
@@ -14,18 +16,18 @@ following will output a list of processes running in the container:
# runc exec <container-id> ps

# OPTIONS
--console value specify the pty slave path for use with the container
--cwd value current working directory in the container
--env value, -e value set environment variables
--tty, -t allocate a pseudo-TTY
--user value, -u value UID (format: <uid>[:<gid>])
--additional-gids value, -g value additional gids
--process value, -p value path to the process.json
--detach, -d detach from the container's process
--pid-file value specify the file to write the process id to
--process-label value set the asm process label for the process commonly used with selinux
--apparmor value set the apparmor profile for the process
--no-new-privs set the no new privileges value for the process
--cap value, -c value add a capability to the bounding set for the process
--no-subreaper disable the use of the subreaper used to reap reparented processes
--preserve-fds value pass N additional file descriptors to the container (stdio + $LISTEN_FDS + N in total) (default: 0)
--console value specify the pty slave path for use with the container
--cwd value current working directory in the container
--env value, -e value set environment variables
--tty, -t allocate a pseudo-TTY
--user value, -u value UID (format: <uid>[:<gid>])
--additional-gids value, -g value additional gids
--process value, -p value path to the process.json
--detach, -d detach from the container's process
--pid-file value specify the file to write the process id to
--process-label value set the asm process label for the process commonly used with selinux
--apparmor value set the apparmor profile for the process
--no-new-privs set the no new privileges value for the process
--cap value, -c value add a capability to the bounding set for the process
--no-subreaper disable the use of the subreaper used to reap reparented processes
--preserve-fds value pass N additional file descriptors to the container (stdio + $LISTEN_FDS + N in total) (default: 0)
@@ -1,14 +1,16 @@
% runc-kill "8"

# NAME
runc kill - kill sends the specified signal (default: SIGTERM) to the container's init process

# SYNOPSIS
runc kill [command options] <container-id> <signal>
runc kill [command options] `<container-id>` `<signal>`

Where "<container-id>" is the name for the instance of the container and
"<signal>" is the signal to be sent to the init process.
Where "`<container-id>`" is the name for the instance of the container and
"`<signal>`" is the signal to be sent to the init process.

# OPTIONS
--all, -a send the specified signal to all processes inside the container
--all, -a send the specified signal to all processes inside the container

# EXAMPLE

@@ -1,3 +1,5 @@
% runc-list "8"

# NAME
runc list - lists containers started by runc with the given root

@@ -15,5 +17,5 @@ To list containers created using a non-default value for "--root":
# runc --root value list

# OPTIONS
--format value, -f value select one of: table or json (default: "table")
--quiet, -q display only container IDs
--format value, -f value select one of: table or json (default: "table")
--quiet, -q display only container IDs
@@ -1,10 +1,12 @@
% runc-pause "8"

# NAME
runc pause - pause suspends all processes inside the container

# SYNOPSIS
runc pause <container-id>
runc pause `<container-id>`

Where "<container-id>" is the name for the instance of the container to be
Where "`<container-id>`" is the name for the instance of the container to be
paused.

# DESCRIPTION
@@ -1,13 +1,15 @@
% runc-ps "8"

# NAME
runc ps - ps displays the processes running inside a container

# SYNOPSIS
runc ps [command options] <container-id> [ps options]
runc ps [command options] `<container-id>` [ps options]

# OPTIONS
--format value, -f value select one of: table(default) or json
--format value, -f value select one of: table(default) or json

The default format is table. The following will output the processes of a container
The default format is table. The following will output the processes of a container
in json format:

# runc ps -f json <container-id>
@@ -1,26 +1,28 @@
% runc-restore "8"

# NAME
runc restore - restore a container from a previous checkpoint

# SYNOPSIS
runc restore [command options] <container-id>
runc restore [command options] `<container-id>`

Where "<container-id>" is the name for the instance of the container to be
Where "`<container-id>`" is the name for the instance of the container to be
restored.

# DESCRIPTION
Restores the saved state of the container instance that was previously saved
using the runc checkpoint command.

# OPTIONS
--image-path value path to criu image files for restoring
--work-path value path for saving work files and logs
--tcp-established allow open tcp connections
--ext-unix-sk allow external unix sockets
--shell-job allow shell jobs
--file-locks handle file locks, for safety
--manage-cgroups-mode value cgroups mode: 'soft' (default), 'full' and 'strict'
--bundle value, -b value path to the root of the bundle directory
--detach, -d detach from the container's process
--pid-file value specify the file to write the process id to
--no-subreaper disable the use of the subreaper used to reap reparented processes
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
--image-path value path to criu image files for restoring
--work-path value path for saving work files and logs
--tcp-established allow open tcp connections
--ext-unix-sk allow external unix sockets
--shell-job allow shell jobs
--file-locks handle file locks, for safety
--manage-cgroups-mode value cgroups mode: 'soft' (default), 'full' and 'strict'
--bundle value, -b value path to the root of the bundle directory
--detach, -d detach from the container's process
--pid-file value specify the file to write the process id to
--no-subreaper disable the use of the subreaper used to reap reparented processes
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
@@ -1,10 +1,12 @@
% runc-resume "8"

# NAME
runc resume - resumes all processes that have been previously paused

# SYNOPSIS
runc resume <container-id>
runc resume `<container-id>`

Where "<container-id>" is the name for the instance of the container to be
Where "`<container-id>`" is the name for the instance of the container to be
resumed.

# DESCRIPTION
@@ -1,10 +1,12 @@
% runc-run "8"

# NAME
runc run - create and run a container

# SYNOPSIS
runc run [command options] <container-id>
runc run [command options] `<container-id>`

Where "<container-id>" is your name for the instance of the container that you
Where "`<container-id>`" is your name for the instance of the container that you
are starting. The name you provide for the container instance must be unique on
your host.

@@ -19,11 +21,11 @@ command(s) that get executed on start, edit the args parameter of the spec. See
"runc spec --help" for more explanation.

# OPTIONS
--bundle value, -b value path to the root of the bundle directory, defaults to the current directory
--console-socket value path to an AF_UNIX socket which will receive a file descriptor referencing the master end of the console's pseudoterminal
--detach, -d detach from the container's process
--pid-file value specify the file to write the process id to
--no-subreaper disable the use of the subreaper used to reap reparented processes
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
--no-new-keyring do not create a new session keyring for the container. This will cause the container to inherit the calling processes session key
--preserve-fds value Pass N additional file descriptors to the container (stdio + $LISTEN_FDS + N in total) (default: 0)
--bundle value, -b value path to the root of the bundle directory, defaults to the current directory
--console-socket value path to an AF_UNIX socket which will receive a file descriptor referencing the master end of the console's pseudoterminal
--detach, -d detach from the container's process
--pid-file value specify the file to write the process id to
--no-subreaper disable the use of the subreaper used to reap reparented processes
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
--no-new-keyring do not create a new session keyring for the container. This will cause the container to inherit the calling processes session key
--preserve-fds value Pass N additional file descriptors to the container (stdio + $LISTEN_FDS + N in total) (default: 0)
@@ -1,3 +1,5 @@
% runc-spec "8"

# NAME
runc spec - create a new specification file

@@ -45,8 +47,10 @@ already running as root, you can use sudo to give runc root privilege. For
example: "sudo runc start container1" will give runc root privilege to start the
container on your host.

Alternatively, you can start a rootless container, which has the ability to run without root privileges. For this to work, the specification file needs to be adjusted accordingly. You can pass the parameter --rootless to this command to generate a proper rootless spec file.
Alternatively, you can start a rootless container, which has the ability to run without root privileges.
For this to work, the specification file needs to be adjusted accordingly.
You can pass the parameter **--rootless** to this command to generate a proper rootless spec file.

# OPTIONS
--bundle value, -b value path to the root of the bundle directory
--rootless generate a configuration for a rootless container
--bundle value, -b value path to the root of the bundle directory
--rootless generate a configuration for a rootless container
@@ -1,10 +1,12 @@
% runc-start "8"

# NAME
runc start - start executes the user defined process in a created container

# SYNOPSIS
runc start <container-id>
runc start `<container-id>`

Where "<container-id>" is your name for the instance of the container that you
Where "`<container-id>`" is your name for the instance of the container that you
are starting. The name you provide for the container instance must be unique on
your host.

@@ -1,10 +1,12 @@
% runc-state "8"

# NAME
runc state - output the state of a container

# SYNOPSIS
runc state <container-id>
runc state `<container-id>`

Where "<container-id>" is your name for the instance of the container.
Where "`<container-id>`" is your name for the instance of the container.

# DESCRIPTION
The state command outputs current state information for the

0 comments on commit 1712af0

Please sign in to comment.
You can’t perform that action at this time.