Add command to generate man pages
The climan package has a command that can be registered with any urfav cli app to generate man pages. Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
This commit is contained in:
Michael Crosby
@@ -1,61 +0,0 @@
|
||||
# containerd 1 01/29/2018
|
||||
|
||||
## NAME
|
||||
|
||||
containerd - an industry-standard container runtime with an emphasis on simplicity,
|
||||
robustness and portability
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
containerd [global options] command [command options] [arguments...]
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
**containerd** is a high performance container runtime whose daemon can be started
|
||||
by using this command. If none of the *config*, *publish*, or *help* commands
|
||||
are specified, the default action of the **containerd** command is to start the
|
||||
containerd daemon in the foreground.
|
||||
|
||||
A default configuration is used if no TOML configuration is specified or located
|
||||
at the default file location. The *containerd config* command can be used to
|
||||
generate the default configuration for containerd. The output of that command
|
||||
can be used and modified as necessary as a custom configuration.
|
||||
|
||||
The *publish* command is used internally by parts of the containerd runtime
|
||||
to publish events. It is not meant to be used as a standalone utility.
|
||||
|
||||
## OPTIONS
|
||||
|
||||
**--config value, -c value**
|
||||
: Specify the default path to the configuration file (default: "/etc/containerd/config.toml")
|
||||
|
||||
**--log-level value, -l value**
|
||||
: Set the logging level. Available levels are: [debug, info, warn, error, fatal, panic]
|
||||
|
||||
**--address value, -a value**
|
||||
: UNIX socket address for containerd's GRPC server to listen on (default: "/run/containerd/containerd.sock")
|
||||
|
||||
**--root value**
|
||||
: The containerd root directory (default: "/var/lib/containerd"). A persistent directory location where metadata and image content are stored
|
||||
|
||||
**--state value**
|
||||
: The containerd state directory (default: "/run/containerd"). A transient state directory used during containerd operation
|
||||
|
||||
**--help, -h**
|
||||
: Show containerd command help text
|
||||
|
||||
**--version, -v**
|
||||
: Print the containerd server version
|
||||
|
||||
## BUGS
|
||||
|
||||
Please file any specific issues that you encounter at
|
||||
https://github.com/containerd/containerd.
|
||||
|
||||
## AUTHOR
|
||||
|
||||
Phil Estes <estesp@gmail.com>
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
ctr(1), containerd-config(1), containerd-config.toml(5)
|
||||
@@ -1,98 +0,0 @@
|
||||
# ctr 1 01/30/2018
|
||||
|
||||
## NAME
|
||||
|
||||
ctr - command line for containerd
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
**ctr [global options] command [command options] [arguments...]**
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
**ctr** is an unsupported debug and administrative client for interacting
|
||||
with the containerd daemon. Because it is unsupported, the commands,
|
||||
options, and operations are not guaranteed to be backward compatible or
|
||||
stable from release to release of the containerd project.
|
||||
|
||||
## OPTIONS
|
||||
|
||||
The following commands are available in the **ctr** utility:
|
||||
|
||||
**plugins,plugin**
|
||||
: Provides information about containerd plugins
|
||||
|
||||
**version**
|
||||
: Prints the client and server versions
|
||||
|
||||
**containers,c,container**
|
||||
: Manages and interacts with containers
|
||||
|
||||
**content**
|
||||
: Manages and interacts with content
|
||||
|
||||
**events,event**
|
||||
: Displays containerd events
|
||||
|
||||
**images,image**
|
||||
: Manages and interacts with images
|
||||
|
||||
**namespaces,namespace**
|
||||
: Manages and interacts with containerd namespaces
|
||||
|
||||
**pprof**
|
||||
: Provides golang pprof outputs for containerd
|
||||
|
||||
**run**
|
||||
: Runs a container
|
||||
|
||||
**snapshots,snapshot**
|
||||
: Manages and interacts with snapshots
|
||||
|
||||
**tasks,t,task**
|
||||
: Manages and interacts with tasks
|
||||
|
||||
**shim**
|
||||
: Interacts with a containerd shim directly
|
||||
|
||||
**help,h**
|
||||
: Displays a list of commands or help for one specific command
|
||||
|
||||
The following global options apply to all **ctr** commands:
|
||||
|
||||
**--debug**
|
||||
: Enable debug output in logs
|
||||
|
||||
**--address value, -a value**
|
||||
: Address for containerd's GRPC server (default: */run/containerd/containerd.sock*)
|
||||
|
||||
**--timeout value**
|
||||
: Total timeout for ctr commands (default: *0s*)
|
||||
|
||||
**--connect-timeout value**
|
||||
: Timeout for connecting to containerd (default: *0s*)
|
||||
|
||||
**--namespace value, -n value**
|
||||
: Namespace to use with commands (default: *default*) [also read from *$CONTAINERD_NAMESPACE*]
|
||||
|
||||
**--help, -h**
|
||||
: Show help text
|
||||
|
||||
**--version, -v**
|
||||
: Prints the **ctr** version
|
||||
|
||||
## BUGS
|
||||
|
||||
Note that the **ctr** utility is not an officially supported part of the
|
||||
containerd project releases.
|
||||
|
||||
However, please feel free to file any specific issues that you encounter at
|
||||
https://github.com/containerd/containerd.
|
||||
|
||||
## AUTHOR
|
||||
|
||||
Phil Estes <estesp@gmail.com>
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
containerd(1), containerd-config(1), containerd-config.toml(5)
|
||||
Reference in New Issue
Block a user