.TH nickel 1M "" " "
.SH NAME
nickel - Network related Information Collector, Keeper and ELaborator
.SH SYNOPSIS
.P
\fBnickel\fP [\fB-m\fP \fIemail-address\fP|\fB-o\fP \fIoutput-directory\fP|\fB-n\fP|\fB-?\fP]
.SH DESCRIPTION
.P
\fInickel\fP is a shell script that gathers system relevant data on a 
HP-UX system (10.x or 11.x) and converts the output to html. You can
either create a archive from the output, email the output, or save the
collected data in a local directory.
.P
Unless you've redirected your output with the -o option, you'll find a file
called index.html in the /tmp/nickel.\fB`hostname`\fP directory, open it with 
your favourite Web browser to see the output of the script.

.P
The Script could be used as a System Administration Tool.
.SS OPTIONS
.CR nickel
recognizes the following command line options:
.RS
.TP 20
.CI \-n
Specify that no archive will be created.
If this option is omitted,
.CR nickel
will create a archive in the /tmp/nickel.\fB`hostname`\fP directory.
.TP
.CI \-m \0email-address
Specify the email address you'd like to send the output to.
.TP
.CI \-o \0output-directory
direct the output to the specified directory, can be used in conjunction
with the 
.CR -n
option.
.TP
.CI \-?
online help
.\" The following shows the related files
There are a few other options, "hardcoded" in the script itself, e.g.
the colors, vmstat/iostat/sar options.
.SH EXAMPLES
Create a sample output in the \fI/webserver/documents/nickel/agram\fP directory:
.IP
.C nickel -n -o /webserver/documents/nickel/agram
.PP
Execute \fBnickel\fP on a System called \fIpluto\fP to collect data from a
System called \fIneptun\fP and copy the data to the webserver documents 
directory \fI/web/docs/systems/nickel.neptun\fP located on \fIpluto\fP:
.IP
First, make sure \fIpluto\fP is added to root's \fB.rhosts\fP file on \fIneptun\fP,
otherwise the remote execution of \fBnickel\fP will fail.
.IP
I.e. make sure that there is an entry like \fIpluto\fP in the \fB.rhosts\fP file
of the root user on neptun. To verify the correct settings, please execute
.C remsh neptun -l root date
.IP
Make sure this command works (i.e. displays the date) before going on.
.IP
Then, run \fBnickel\fP on \fIneptun\fP, e.g.:
.IP
.C remsh neptun -l root /opt/contrib/bin/nickel -n -o /tmp/nickel.neptun
.IP
Now, copy the output back to \fIpluto\fP:
.IP
.C rcp -p -r root@neptun:/tmp/nickel.neptun /web/docs/systems
.IP
You might want to setup a \fBcron\fP job via \fBcrontab\fP to execute the above
script.
.\" Other references
.SH SEE ALSO
sh-posix(1), awk(1), sed(1), grep(1), linkloop(1M), lanadmin(1M), lanscan(1M), hostname(1), cron(1M).
.SH AUTHOR
nickel was developed by Robert Sakic (Robert_Sakic@hp.com), HP Germany.
.SH FILES
/opt/contrib/bin/nickel
.P
/opt/contrib/man/man1m/nickel.1m
.SH LIMITATIONS
This program must be executed as the root user (ID 0).