containerd/docs/man/containerd-config.1.md
Aleksa Sarai 7aa132ffc7
docs: man: rename config.toml(5) to be more descriptive
The man page namespace is global, so in order to avoid colliding with
other man pages named "config.toml" rename ours to be more descriptive.
This also helps with discoverability (now tab-completion of 'man
containerd<tab>' will return the config man page), as well as making it
much cleaner from the perspective of distributions that want to package
containerd.

Signed-off-by: Aleksa Sarai <asarai@suse.de>
2018-08-08 18:33:29 +10:00

38 lines
995 B
Markdown

# containerd-config 1 01/30/2018
## SYNOPSIS
containerd config [command]
## DESCRIPTION
The *containerd config* command has one subcommand, named *default*, which
will display on standard output the default containerd config for this version
of the containerd daemon.
This output can be piped to a __containerd-config.toml(5)__ file and placed in
**/etc/containerd** to be used as the configuration for containerd on daemon
startup. The configuration can be placed in any filesystem location and used
with the **--config** option to the containerd daemon as well.
See __containerd-config.toml(5)__ for more information on the containerd
configuration options.
## OPTIONS
**default**
: This subcommand will output the TOML formatted containerd configuration to standard output
## 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(1), containerd-config.toml(5)