diff options
Diffstat (limited to 'distro/common/man/man1/knife-edit.1')
| -rw-r--r-- | distro/common/man/man1/knife-edit.1 | 34 |
1 files changed, 19 insertions, 15 deletions
diff --git a/distro/common/man/man1/knife-edit.1 b/distro/common/man/man1/knife-edit.1 index aa9919b1a7..1c78babbd7 100644 --- a/distro/common/man/man1/knife-edit.1 +++ b/distro/common/man/man1/knife-edit.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-EDIT" "1" "Chef 11.10.0" "" "knife edit" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-EDIT" "1" "Chef 11.12.0" "" "knife edit" .SH NAME knife-edit \- The man page for the knife edit subcommand. . @@ -28,20 +30,22 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.\" Man page generated from reStructuredText. -. .sp -The \fBknife edit\fP subcommand is used to edit objects on the server. This subcommand works similar to \fBknife cookbook edit\fP, \fBknife data bag edit\fP, \fBknife environment edit\fP, \fBknife node edit\fP, and \fBknife role edit\fP, but with a single verb (and a single action). +The \fBknife edit\fP subcommand is used to edit objects on the Chef server\&. This subcommand works similar to \fBknife cookbook edit\fP, \fBknife data bag edit\fP, \fBknife environment edit\fP, \fBknife node edit\fP, and \fBknife role edit\fP, but with a single verb (and a single action). .sp \fBSyntax\fP .sp -This argument has the following syntax: +This subcommand has the following syntax: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife edit (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -52,7 +56,7 @@ This subcommand has the following options: The configuration file to use. .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. +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. @@ -61,7 +65,7 @@ The port on which chef\-zero will listen. Indicates whether colored output will be used. .TP .B \fB\-\-concurrency\fP -The number of allowed concurrent connections. Default: \fB10\fP. +The number of allowed concurrent connections. Default: \fB10\fP\&. .TP .B \fB\-d\fP, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. @@ -76,31 +80,31 @@ The $EDITOR that is used for all interactive commands. 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 FORMAT\fP, \fB\-\-format FORMAT\fP -The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP. +The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&. .TP .B \fB\-h\fP, \fB\-\-help\fP Shows help for the command. .TP .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. +The private key that Knife will use to sign requests made by the API client to the Chef server\&. .TP .B \fB\-\-local\fP -Use to show files in the local chef\-repo instead of a remote location. Default: \fBfalse\fP. +Use to show files in the local chef\-repo instead of a remote location. Default: \fBfalse\fP\&. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .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. +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. +The URL for the Chef server\&. .TP .B \fB\-u USER\fP, \fB\-\-user USER\fP -The user name used by Knife to sign requests made by the API client to the server. Authentication will fail if the user name does not match the private key. +The user name used by Knife to sign requests made by the API client to the Chef server\&. Authentication will fail if the user name does not match the private key. .TP .B \fB\-v\fP, \fB\-\-version\fP -The version of the chef\-client. +The version of the chef\-client\&. .TP .B \fB\-V\fP, \fB\-\-verbose\fP Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. @@ -109,7 +113,7 @@ Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. Indicates that the response to all confirmation prompts will be "Yes" (and that Knife will not ask for confirmation). .TP .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. +Indicates that the chef\-client will be run in local mode, which allows all commands that work against the Chef server to also work against the local chef\-repo\&. .UNINDENT .SH AUTHOR Chef |