1
0
mirror of https://github.com/opencontainers/runc.git synced 2025-11-02 04:13:26 +03:00
Files
runc/man/runc-exec.8.md
Adrian Reber 1712af0e80 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>
2019-08-06 21:29:31 +02:00

1.8 KiB

% runc-exec "8"

NAME

runc exec - execute new process inside the container

SYNOPSIS

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.

EXAMPLE

For example, if the container is configured to run the linux ps command the 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)