diff options
Diffstat (limited to 'distro/common/man/man1/knife-xargs.1')
| -rw-r--r-- | distro/common/man/man1/knife-xargs.1 | 114 |
1 files changed, 61 insertions, 53 deletions
diff --git a/distro/common/man/man1/knife-xargs.1 b/distro/common/man/man1/knife-xargs.1 index b0e8f0b22d..82e3981471 100644 --- a/distro/common/man/man1/knife-xargs.1 +++ b/distro/common/man/man1/knife-xargs.1 @@ -1,4 +1,6 @@ -.TH "KNIFE-XARGS" "1" "Chef 11.10.0" "" "knife xargs" +.\" Man page generated from reStructuredText. +. +.TH "KNIFE-XARGS" "1" "Chef 11.12.0" "" "knife xargs" .SH NAME knife-xargs \- The man page for the knife xargs 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 xargs\fP subcommand is used to build and execute command lines against objects on a server using standard input. +The \fBknife xargs\fP subcommand is used to build and execute command lines against objects on a Chef server using standard input. .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 xargs [PATTERN...] (options) .ft P .fi +.UNINDENT +.UNINDENT .sp \fBOptions\fP .sp @@ -49,35 +53,59 @@ This subcommand has the following options: .INDENT 0.0 .TP .B \fB\-0\fP -Indicates that a \fBNULL\fP character (\fB\e0\fP) will be used as a separator, instead of white space. Default: \fBfalse\fP. +Indicates that a \fBNULL\fP character (\fB\e0\fP) will be used as a separator, instead of white space. 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 +Indicates that a command line will be built or executed 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 +Indicates that the print command will be run 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\-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\-\-[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, \fB\-\-disable\-editing\fP Indicates that $EDITOR will not be opened; data will be accepted as\-is. .TP .B \fB\-\-defaults\fP Indicates that Knife will use the default value, instead of asking a user to provide one. .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 server. Default: \fBfalse\fP. -.TP .B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP The $EDITOR that is used for all interactive commands. .TP @@ -85,52 +113,28 @@ 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. -.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. +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 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\-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 -Indicates that a command line will be built or executed 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. +.B \fB\-\-[no\-]color\fP +Indicates whether colored output will be used. .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 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\-\-server\-url URL\fP -The URL for the server. -.TP -.B \fB\-t\fP -Indicates that the print command will be run on the command line. Default: \fBnil\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 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. @@ -139,16 +143,20 @@ 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 +.INDENT 0.0 +.INDENT 3.5 .sp .nf .ft C $ knife deps nodes/*.json | xargs knife upload .ft P .fi +.UNINDENT +.UNINDENT .SH AUTHOR Chef .\" Generated by docutils manpage writer. |