summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjamescott <jamescott@opscode.com>2013-10-22 09:48:19 -0700
committerjamescott <jamescott@opscode.com>2013-10-22 09:48:37 -0700
commit4d4a95b2c79d001c1d0df96b4d0ccec2a4f945c9 (patch)
treed27384e236e27f34eed6a2096695b19c185b97b2
parent07bd8b7b55da38e0f4d9f1b485d1bb6fea1b36b8 (diff)
downloadohai-4d4a95b2c79d001c1d0df96b4d0ccec2a4f945c9.tar.gz
update Ohai man page
-rw-r--r--docs/man/man1/ohai.198
1 files changed, 80 insertions, 18 deletions
diff --git a/docs/man/man1/ohai.1 b/docs/man/man1/ohai.1
index 6474d31a..1a06bb74 100644
--- a/docs/man/man1/ohai.1
+++ b/docs/man/man1/ohai.1
@@ -1,23 +1,85 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
-.TH OHAI "1" "April 2009" "ohai" "User Commands"
+.TH "OHAI" "1" "Ohai 6.20.0" "" "ohai"
.SH NAME
-ohai \- collect system information
-.SH SYNOPSIS
-.B ohai
-[\fIOPTION\fR]...
-.SH DESCRIPTION
-Information about your system is collected and returned as multidimensional
-attributes in a JSON format.
+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
-\fB\-d\fR, \fB\-\-directory\fR NAME
-A directory to add to the Ohai search path
+.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
-\fB\-f\fR, \fB\-\-file\fR NAME
-A file to run Ohai against
+.B \fB\-f FILE_NAME\fP, \fB\-\-file FILE_NAME\fP
+The file against which Ohai will run.
.TP
-\fB\-l\fR, \fB\-\-loglevel\fR NAME
-Set log level for Ohai
+.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
-\fB\-h\fR, \fB\-\-help\fR
-Show this message
-.IP
+.B \fB\-h\fP, \fB\-\-help\fP
+Shows help for the command.
+.UNINDENT
+.SH AUTHOR
+Opscode
+.\" Generated by docutils manpage writer.
+.