summaryrefslogtreecommitdiff
path: root/distro
diff options
context:
space:
mode:
authorjamescott <jscott@Ettores-MacBook-Pro-2.local>2014-12-08 14:45:49 -0800
committerjamescott <jscott@Ettores-MacBook-Pro-2.local>2014-12-08 14:45:49 -0800
commit6abcfbf4531d9375093d0bc1664f9126ac1df21a (patch)
tree3754e984d7d02a63dc027db1083c357cc4f75098 /distro
parentd65d1c2879025a5648c7cea03c3798cf8bb4bd94 (diff)
downloadchef-6abcfbf4531d9375093d0bc1664f9126ac1df21a.tar.gz
add man page for chef-apply
Diffstat (limited to 'distro')
-rw-r--r--distro/common/man/man8/chef-apply.886
1 files changed, 86 insertions, 0 deletions
diff --git a/distro/common/man/man8/chef-apply.8 b/distro/common/man/man8/chef-apply.8
new file mode 100644
index 0000000000..b12f01e886
--- /dev/null
+++ b/distro/common/man/man8/chef-apply.8
@@ -0,0 +1,86 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "CHEF-APPLY" "8" "Chef 12.0" "" "chef-client"
+.SH NAME
+chef-apply \- The man page for the chef-apply command line tool.
+.
+.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
+chef\-apply allows a single recipe to be run from the command line.
+.SH OPTIONS
+.sp
+This command has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+chef\-apply name_of_recipe.rb
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This tool has the following options:
+.INDENT 0.0
+.TP
+.B \fB\-e RECIPE_TEXT\fP, \fB\-\-execute RECIPE_TEXT\fP
+Use to execute a resource using a string.
+.TP
+.B \fB\-l LEVEL\fP, \fB\-\-log_level LEVEL\fP
+The level of logging that will be stored in a log file.
+.TP
+.B \fB\-s\fP, \fB\-\-stdin\fP
+Use to execute a resource using standard input.
+.TP
+.B \fB\-v\fP, \fB\-\-version\fP
+The version of the chef\-client\&.
+.TP
+.B \fB\-W\fP, \fB\-\-why\-run\fP
+Use to run the executable in why\-run mode, which is a type of chef\-client run that does everything except modify the system. Use why\-run mode to understand why the chef\-client makes the decisions that it makes and to learn more about the current and proposed state of the system.
+.TP
+.B \fB\-h\fP, \fB\-\-help\fP
+Shows help for the command.
+.UNINDENT
+.SH EXAMPLES
+.sp
+To use chef\-apply to run a recipe named \fBmachinations.rb\fP, enter the following:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ chef\-apply machinations.rb
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH AUTHOR
+Chef
+.\" Generated by docutils manpage writer.
+.