diff options
Diffstat (limited to 'distro/common/man/man1/ohai.1')
| -rw-r--r-- | distro/common/man/man1/ohai.1 | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/distro/common/man/man1/ohai.1 b/distro/common/man/man1/ohai.1 new file mode 100644 index 0000000000..1a06bb74ff --- /dev/null +++ b/distro/common/man/man1/ohai.1 @@ -0,0 +1,85 @@ +.TH "OHAI" "1" "Ohai 6.20.0" "" "ohai" +.SH NAME +ohai \- The man page for the ohai 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 +.. +.\" Man page generated from reStructuredText. +. +.sp +Ohai is a tool that is used to detect attributes on a node, and then provide these attributes to the chef\-client at the start of every chef\-client run. Ohai is required by the chef\-client and must be present on a node. The types of attributes Ohai collects include: +.INDENT 0.0 +.IP \(bu 2 +Platform details +.IP \(bu 2 +Networking usage +.IP \(bu 2 +Memory usage +.IP \(bu 2 +Processor usage +.IP \(bu 2 +Kernel data +.IP \(bu 2 +Host names +.IP \(bu 2 +Fully qualified domain names +.IP \(bu 2 +Other configuration details +.UNINDENT +.sp +Attributes that are collected by Ohai are automatic attributes, in that these attributes are used by the chef\-client to ensure that these attributes remain unchanged after the chef\-client is done configuring the node. +.sp +ohai is the command\-line interface for Ohai, a tool that is used to detect attributes on a node, and then provide these attributes to the chef\-client at the start of every chef\-client run. +.SH OPTIONS +.sp +This command has the following syntax: +.sp +.nf +.ft C +ohai OPTION +.ft P +.fi +.sp +This tool has the following options: +.INDENT 0.0 +.TP +.B \fB\-d PATH\fP, \fB\-\-directory PATH\fP +The directory in which Ohai plugins are located. For example: \fB/etc/ohai/plugins\fP. +.TP +.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP +The file against which Ohai will run. +.TP +.B \fB\-l LEVEL\fP, \fB\-\-log_level LEVEL\fP +The level of logging that will be stored in a log file: \fBdebug\fP, \fBinfo\fP, \fBwarn\fP, \fBerror\fP, or \fBfatal\fP. +.TP +.B \fB\-h\fP, \fB\-\-help\fP +Shows help for the command. +.UNINDENT +.SH AUTHOR +Opscode +.\" Generated by docutils manpage writer. +. |