diff options
Diffstat (limited to 'distro/common/man/man1/knife-raw.1')
| -rw-r--r-- | distro/common/man/man1/knife-raw.1 | 46 |
1 files changed, 33 insertions, 13 deletions
diff --git a/distro/common/man/man1/knife-raw.1 b/distro/common/man/man1/knife-raw.1 index 4965ea315b..533b0e1bde 100644 --- a/distro/common/man/man1/knife-raw.1 +++ b/distro/common/man/man1/knife-raw.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-RAW" "1" "Chef 11.10.0" "" "knife raw" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-RAW" "1" "Chef 11.12.0" "" "knife raw" .SH NAME knife-raw \- The man page for the knife raw 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 raw\fP subcommand is used to send a REST request to a specified path using the Chef Server API. +The \fBknife raw\fP subcommand is used to send a REST request to a specified path using the Chef Server API\&. .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 raw REQUEST_PATH (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -70,7 +74,7 @@ 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. @@ -79,25 +83,25 @@ Shows help for the command. The name of a file to be used with the \fBPUT\fP or a \fBPOST\fP request. .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\-m METHOD\fP, \fB\-\-method METHOD\fP -The request method: \fBDELETE\fP, \fBGET\fP, \fBPOST\fP, or \fBPUT\fP. Default value: \fBGET\fP. +The request method: \fBDELETE\fP, \fBGET\fP, \fBPOST\fP, or \fBPUT\fP\&. Default value: \fBGET\fP\&. .TP .B \fB\-\-[no\-]pretty\fP -Use \fB\-\-no\-pretty\fP to disable pretty\-print output for JSON. Default: \fB\-\-pretty\fP. +Use \fB\-\-no\-pretty\fP to disable pretty\-print output for JSON\&. Default: \fB\-\-pretty\fP\&. .TP .B \fB\-\-print\-after\fP Indicates that data will be shown after a destructive operation. .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. @@ -106,36 +110,50 @@ 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 .sp \fBExamples\fP .sp To view information about a client: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife raw /clients/<client_name> .ft P .fi +.UNINDENT +.UNINDENT .sp To view information about a node: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C knife raw /nodes/<node_name> .ft P .fi +.UNINDENT +.UNINDENT .sp To delete a data bag, enter a command similar to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife raw \-m DELETE /data/foo .ft P .fi +.UNINDENT +.UNINDENT .sp to return something similar to: +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C @@ -146,6 +164,8 @@ to return something similar to: } .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. |