diff options
author | Tim Smith <tsmith@chef.io> | 2018-03-11 13:18:22 -0700 |
---|---|---|
committer | Tim Smith <tsmith@chef.io> | 2018-03-11 13:18:22 -0700 |
commit | 7216ac7e617df192227e1633570ce977a29471a2 (patch) | |
tree | e117b08e9737678eb12e396b5acdc8e6747676ee /distro/common/man/man1/knife-raw.1 | |
parent | 84ea1415f0a31780d3ff03de340e32af23ff62c4 (diff) | |
download | chef-7216ac7e617df192227e1633570ce977a29471a2.tar.gz |
Remove the manpagesmanpages
These are horribly outdated and we shouldn't have people using them for decision making
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'distro/common/man/man1/knife-raw.1')
-rw-r--r-- | distro/common/man/man1/knife-raw.1 | 172 |
1 files changed, 0 insertions, 172 deletions
diff --git a/distro/common/man/man1/knife-raw.1 b/distro/common/man/man1/knife-raw.1 deleted file mode 100644 index a484db25bb..0000000000 --- a/distro/common/man/man1/knife-raw.1 +++ /dev/null @@ -1,172 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-RAW" "1" "Chef 12.0" "" "knife raw" -.SH NAME -knife-raw \- The man page for the knife raw subcommand. -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.sp -The \fBknife raw\fP subcommand is used to send a REST request to an endpoint in the Chef server API\&. -.sp -\fBSyntax\fP -.sp -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 -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP -The configuration file to use. -.TP -.B \fB\-\-chef\-zero\-port PORT\fP -The port on which chef\-zero will listen. -.TP -.B \fB\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-d\fP, \fB\-\-disable\-editing\fP -Use to prevent the $EDITOR from being opened and to accept data as\-is. -.TP -.B \fB\-\-defaults\fP -Use to have knife use the default value instead of asking a user to provide one. -.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 FORMAT\fP, \fB\-\-format FORMAT\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\-i FILE\fP, \fB\-\-input FILE\fP -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 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\&. -.TP -.B \fB\-\-[no\-]pretty\fP -Use \fB\-\-no\-pretty\fP to disable pretty\-print output for JSON\&. Default: \fB\-\-pretty\fP\&. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP -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 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\&. -.TP -.B \fB\-V\fP, \fB\-\-verbose\fP -Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity. -.TP -.B \fB\-y\fP, \fB\-\-yes\fP -Use to respond to all confirmation prompts with "Yes". knife will not ask for confirmation. -.TP -.B \fB\-z\fP, \fB\-\-local\-mode\fP -Use to run the chef\-client in local mode. This 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 -{ - "name":"foo", - "json_class":"Chef::DataBag", - "chef_type":"data_bag" -} -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. |