diff options
Diffstat (limited to 'distro/common/man/man1/knife-xargs.1')
| -rw-r--r-- | distro/common/man/man1/knife-xargs.1 | 189 |
1 files changed, 0 insertions, 189 deletions
diff --git a/distro/common/man/man1/knife-xargs.1 b/distro/common/man/man1/knife-xargs.1 deleted file mode 100644 index 1fcc3d9f4a..0000000000 --- a/distro/common/man/man1/knife-xargs.1 +++ /dev/null @@ -1,189 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "KNIFE-XARGS" "1" "Chef 12.0" "" "knife xargs" -.SH NAME -knife-xargs \- The man page for the knife xargs 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 xargs\fP subcommand is used to take patterns from standard input, download as JSON, run a command against the downloaded JSON, and then upload any changes. -.sp -\fBSyntax\fP -.sp -This subcommand has the following syntax: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife xargs [PATTERN...] (options) -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBOptions\fP -.sp -This subcommand has the following options: -.INDENT 0.0 -.TP -.B \fB\-0\fP -Use to show a \fBNULL\fP character (\fB\e0\fP) instead of white space as the separator. Default: \fBfalse\fP\&. -.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\-\-[no\-]diff\fP -Use to show a diff when a file changes. Default: \fB\-\-diff\fP\&. -.TP -.B \fB\-\-dry\-run\fP -Use to prevent changes from being uploaded to the Chef server\&. Default: \fBfalse\fP\&. -.TP -.B \fB\-\-[no\-]force\fP -Use to force the upload of files even if they haven\(aqt been changed. Default: \fB\-\-no\-force\fP\&. -.TP -.B \fB\-I REPLACE_STRING\fP, \fB\-\-replace REPLACE_STRING\fP -Use to define a string that will be used to replace all occurrences of a file name. Default: \fBnil\fP\&. -.TP -.B \fB\-J REPLACE_STRING\fP, \fB\-\-replace\-first REPLACE_STRING\fP -Use to define a string that will be used to replace the first occurrence of a file name. Default: \fBnil\fP\&. -.TP -.B \fB\-\-local\fP -Use to build or execute a command line against a local file. Set to \fBfalse\fP to build or execute against a remote file. Default: \fBfalse\fP\&. -.TP -.B \fB\-n MAX_ARGS\fP, \fB\-\-max\-args MAX_ARGS\fP -The maximum number of arguments per command line. Default: \fBnil\fP\&. -.TP -.B \fB\-p [PATTERN...]\fP, \fB\-\-pattern [PATTERN...]\fP -One (or more) patterns for a command line. If this option is not specified, a list of patterns may be expected on standard input. Default: \fBnil\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 value: \fBdefault\fP\&. -.TP -.B \fB\-s LENGTH\fP, \fB\-\-max\-chars LENGTH\fP -The maximum size (in characters) for a command line. Default: \fBnil\fP\&. -.TP -.B \fB\-t\fP -Use to run the print command on the command line. Default: \fBnil\fP\&. -.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\-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\-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\-\-[no\-]color\fP -Use to view colored output. -.TP -.B \fB\-\-print\-after\fP -Use to show data after a destructive operation. -.TP -.B \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 -The following examples show various ways of listing all nodes on the server, and then using Perl to replace \fBgrantmc\fP with \fBgmc\fP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife list \(aqnodes/*\(aq | knife xargs "perl \-i \-pe \(aqs/grantmc/gmc\(aq" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or without quotes and the backslash escaped: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife list /nodes/\e* | knife xargs "perl \-i \-pe \(aqs/grantmc/gmc\(aq" -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or by using the \fB\-\-pattern\fP option: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ knife xargs \-\-pattern \(aq/nodes.*\(aq "perl \-i \-pe \(aqs/grantmc/gmc\(aq" -.ft P -.fi -.UNINDENT -.UNINDENT -.SH AUTHOR -Chef -.\" Generated by docutils manpage writer. -. |