jasder
/
runc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #2098 from adrianreber/master 

man: fix man-pages
This commit is contained in:
Mrunal Patel 2019-09-09 12:50:17 -07:00 committed by GitHub
parent a6606a7ae9 1712af0e80
commit e7a87dd240
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 176 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
man/runc-checkpoint.8.md
View File

@ -1,10 +1,12 @@
% 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

6
man/runc-create.8.md
View File

@ -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.

6
man/runc-delete.8.md
View File

@ -1,10 +1,12 @@
% 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)

6
man/runc-events.8.md
View File

@ -1,10 +1,12 @@
% 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

8
man/runc-exec.8.md
View File

@ -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

8
man/runc-kill.8.md
View File

@ -1,11 +1,13 @@
% 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

2
man/runc-list.8.md
View File

@ -1,3 +1,5 @@
% runc-list "8"
# NAME
runc list - lists containers started by runc with the given root

6
man/runc-pause.8.md
View File

@ -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

4
man/runc-ps.8.md
View File

@ -1,8 +1,10 @@
% 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

6
man/runc-restore.8.md
View File

@ -1,10 +1,12 @@
% 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

6
man/runc-resume.8.md
View File

@ -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

6
man/runc-run.8.md
View File

@ -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.

6
man/runc-spec.8.md
View File

@ -1,3 +1,5 @@
% runc-spec "8"
# NAME
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
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

6
man/runc-start.8.md
View File

@ -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.

6
man/runc-state.8.md
View File

@ -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

4
man/runc-update.8.md
View File

@ -1,8 +1,10 @@
% runc-update "8"
# NAME
runc update - update container resource constraints
# SYNOPSIS
runc update [command options] <container-id>
runc update [command options] `<container-id>`
# DESCRIPTION
The data can be read from a file or the standard input, the

4
man/runc.8.md
View File

@ -1,3 +1,5 @@
% runc "8"
# NAME
runc - Open Container Initiative runtime
@ -22,7 +24,7 @@ To start a new instance of a container:
# 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
your host. Providing the bundle directory using "-b" is optional. The default
value for "bundle" is the current directory.