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>
This commit is contained in:
parent
2e94378464
commit
1712af0e80
|
@ -1,10 +1,12 @@
|
||||||
|
% runc-checkpoint "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc checkpoint - checkpoint a running container
|
runc checkpoint - checkpoint a running container
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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.
|
checkpointed.
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
|
% runc-create "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc create - create a container
|
runc create - create a container
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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
|
are starting. The name you provide for the container instance must be unique on
|
||||||
your host.
|
your host.
|
||||||
|
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
|
% runc-delete "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc delete - delete any resources held by the container often used with detached container
|
runc delete - delete any resources held by the container often used with detached container
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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
|
# 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)
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
|
% runc-events "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc events - display container events such as OOM notifications, cpu, memory, and IO usage statistics
|
runc events - display container events such as OOM notifications, cpu, memory, and IO usage statistics
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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
|
# DESCRIPTION
|
||||||
The events command displays information about the container. By default the
|
The events command displays information about the container. By default the
|
||||||
|
|
|
@ -1,11 +1,13 @@
|
||||||
|
% runc-exec "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc exec - execute new process inside the container
|
runc exec - execute new process inside the container
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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
|
Where "`<container-id>`" is the name for the instance of the container and
|
||||||
"<container command>" is the command to be executed in the container.
|
"`<container command>`" is the command to be executed in the container.
|
||||||
|
|
||||||
# EXAMPLE
|
# EXAMPLE
|
||||||
For example, if the container is configured to run the linux ps command the
|
For example, if the container is configured to run the linux ps command the
|
||||||
|
|
|
@ -1,11 +1,13 @@
|
||||||
|
% runc-kill "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc kill - kill sends the specified signal (default: SIGTERM) to the container's init process
|
runc kill - kill sends the specified signal (default: SIGTERM) to the container's init process
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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
|
Where "`<container-id>`" is the name for the instance of the container and
|
||||||
"<signal>" is the signal to be sent to the init process.
|
"`<signal>`" is the signal to be sent to the init process.
|
||||||
|
|
||||||
# OPTIONS
|
# 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
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
% runc-list "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc list - lists containers started by runc with the given root
|
runc list - lists containers started by runc with the given root
|
||||||
|
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
|
% runc-pause "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc pause - pause suspends all processes inside the container
|
runc pause - pause suspends all processes inside the container
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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.
|
paused.
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
|
@ -1,8 +1,10 @@
|
||||||
|
% runc-ps "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc ps - ps displays the processes running inside a container
|
runc ps - ps displays the processes running inside a container
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
runc ps [command options] <container-id> [ps options]
|
runc ps [command options] `<container-id>` [ps options]
|
||||||
|
|
||||||
# OPTIONS
|
# OPTIONS
|
||||||
--format value, -f value select one of: table(default) or json
|
--format value, -f value select one of: table(default) or json
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
|
% runc-restore "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc restore - restore a container from a previous checkpoint
|
runc restore - restore a container from a previous checkpoint
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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.
|
restored.
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
|
% runc-resume "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc resume - resumes all processes that have been previously paused
|
runc resume - resumes all processes that have been previously paused
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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.
|
resumed.
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
|
% runc-run "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc run - create and run a container
|
runc run - create and run a container
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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
|
are starting. The name you provide for the container instance must be unique on
|
||||||
your host.
|
your host.
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
% runc-spec "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc spec - create a new specification file
|
runc spec - create a new specification file
|
||||||
|
|
||||||
|
@ -45,7 +47,9 @@ 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
|
example: "sudo runc start container1" will give runc root privilege to start the
|
||||||
container on your host.
|
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
|
# OPTIONS
|
||||||
--bundle value, -b value path to the root of the bundle directory
|
--bundle value, -b value path to the root of the bundle directory
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
|
% runc-start "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc start - start executes the user defined process in a created container
|
runc start - start executes the user defined process in a created container
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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
|
are starting. The name you provide for the container instance must be unique on
|
||||||
your host.
|
your host.
|
||||||
|
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
|
% runc-state "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc state - output the state of a container
|
runc state - output the state of a container
|
||||||
|
|
||||||
# SYNOPSIS
|
# 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
|
# DESCRIPTION
|
||||||
The state command outputs current state information for the
|
The state command outputs current state information for the
|
||||||
|
|
|
@ -1,8 +1,10 @@
|
||||||
|
% runc-update "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc update - update container resource constraints
|
runc update - update container resource constraints
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
runc update [command options] <container-id>
|
runc update [command options] `<container-id>`
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
The data can be read from a file or the standard input, the
|
The data can be read from a file or the standard input, the
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
% runc "8"
|
||||||
|
|
||||||
# NAME
|
# NAME
|
||||||
runc - Open Container Initiative runtime
|
runc - Open Container Initiative runtime
|
||||||
|
|
||||||
|
@ -22,7 +24,7 @@ To start a new instance of a container:
|
||||||
|
|
||||||
# runc start [ -b bundle ] <container-id>
|
# runc start [ -b bundle ] <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
|
are starting. The name you provide for the container instance must be unique on
|
||||||
your host. Providing the bundle directory using "-b" is optional. The default
|
your host. Providing the bundle directory using "-b" is optional. The default
|
||||||
value for "bundle" is the current directory.
|
value for "bundle" is the current directory.
|
||||||
|
|
Loading…
Reference in New Issue