diff options
Diffstat (limited to 'distro/common/man/man1/knife-list.1')
| -rw-r--r-- | distro/common/man/man1/knife-list.1 | 106 |
1 files changed, 47 insertions, 59 deletions
diff --git a/distro/common/man/man1/knife-list.1 b/distro/common/man/man1/knife-list.1 index 2788e5b903..233c9dcc3d 100644 --- a/distro/common/man/man1/knife-list.1 +++ b/distro/common/man/man1/knife-list.1 @@ -33,31 +33,56 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp The \fBknife list\fP subcommand is used to view a list of objects on the server. This subcommand works similar to \fBknife cookbook list\fP, \fBknife data bag list\fP, \fBknife environment list\fP, \fBknife node list\fP, and \fBknife role list\fP, but with a single verb (and a single action). .sp -\fBCommon Options\fP +\fBSyntax\fP +.sp +This argument has the following syntax: +.sp +.nf +.ft C +$ knife list [PATTERN...] (options) +.ft P +.fi +.sp +\fBOptions\fP .sp -The following options can be run with all Knife sub\-commands and plug\-ins: +This subcommand has the following options: .INDENT 0.0 .TP -.B \fB\-c CONFIG\fP, \fB\-\-config CONFIG\fP +.B \fB\-1\fP +Indicates that only one column of results will be shown. Default: \fBfalse\fP. +.TP +.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP The configuration file to use. .TP -.B \fB\-\-color\fP -Indicates that colored output will be used. +.B \fB\-\-chef\-repo\-path PATH\fP +The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. +.TP +.B \fB\-\-chef\-zero\-port PORT\fP +The port on which chef\-zero will listen. .TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Indicates that $EDITOR will not be opened; data will be accepted as\-is. +.B \fB\-\-[no\-]color\fP +Indicates whether colored output will be used. +.TP +.B \fB\-\-concurrency\fP +The number of allowed concurrent connections. Default: \fB10\fP. +.TP +.B \fB\-d\fP +Indicates that a directory\(aqs children will not be shown when a directory matches a pattern. Default value: \fBfalse\fP. .TP .B \fB\-\-defaults\fP Indicates that Knife will use the default value, instead of asking a user to provide one. .TP +.B \fB\-\-disable\-editing\fP +Indicates that $EDITOR will not be opened; data will be accepted as\-is. +.TP .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP The $EDITOR that is used for all interactive commands. .TP .B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP The name of the environment. When this option is added to a command, the command will run only against the named environment. .TP -.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP -Indicates that the private key will be saved to a specified file name. +.B \fB\-f\fP, \fB\-\-flat\fP +Indicates that a list of file names will be shown. Set to \fBfalse\fP to view ls\-like output. Default: \fBfalse\fP. .TP .B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP. @@ -68,15 +93,21 @@ Shows help for the command. .B \fB\-k KEY\fP, \fB\-\-key KEY\fP The private key that Knife will use to sign requests made by the API client to the server. .TP -.B \fB\-\-no\-color\fP -Indicates that color will not be used in the output. +.B \fB\-\-local\fP +Indicates that only contents of the local directory will be returned. Default: \fBfalse\fP. .TP -.B \fB\-p PASSWORD\fP, \fB\-\-password PASSWORD\fP -The user password. +.B \fB\-p\fP +Indicates that trailing slashes (/) will be shown for directories. Default: \fBfalse\fP. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .TP +.B \fB\-R\fP +Indicates that directories will be listed recursively. Default: \fBfalse\fP. +.TP +.B \fB\-\-repo\-mode MODE\fP +The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP. +.TP .B \fB\-s URL\fP, \fB\-\-server\-url URL\fP The URL for the server. .TP @@ -91,52 +122,9 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. .TP .B \fB\-y\fP, \fB\-\-yes\fP Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). -.UNINDENT -.sp -\fBSyntax\fP -.sp -This argument has the following syntax: -.sp -.nf -.ft C -$ knife list [PATTERN...] (options) -.ft P -.fi -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-1\fP -Indicates that only one results column will be shown. -.TP -.B \fB\-\-chef\-repo\-path PATH\fP -The path to the chef\-repo. This setting will override the default path to the chef\-repo. Default: same as specified by \fBchef_repo_path\fP in config.rb. -.TP -.B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. .TP -.B \fB\-d\fP -Indicates that a directory\(aqs children will not be shown when a directory matches a pattern. Default value: \fBfalse\fP. -.TP -.B \fB\-f\fP, \fB\-\-flat\fP -Indicates that a list of file names will be shown. Set to \fBfalse\fP to view ls\-like output. Default: \fBfalse\fP. -.TP -.B \fB\-\-local\fP -Indicates that only contents of the local directory will be returned. Default: \fBfalse\fP. -.TP -.B \fB\-1\fP -Indicates that only one column of results will be shown. Default: \fBfalse\fP. -.TP -.B \fB\-p\fP -Indicates that trailing slashes (/) will be shown for directories. Default: \fBfalse\fP. -.TP -.B \fB\-R\fP -Indicates that directories will be listed recursively. Default: \fBfalse\fP. -.TP -.B \fB\-\-repo\-mode MODE\fP -The layout of the local chef\-repo. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP. +.B \fB\-z\fP, \fB\-\-local\-mode\fP +Indicates that the chef\-client will be run in local mode, which allows all commands that work against the server to also work against the local chef\-repo. .UNINDENT .sp \fBExamples\fP @@ -165,6 +153,6 @@ $ knife list \-R / .ft P .fi .SH AUTHOR -Opscode +Chef .\" Generated by docutils manpage writer. . |