Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add man pages #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ela/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ ela_add_regex_SOURCES = ela/add_regex.cpp \
$(BUILT_SOURCE) \
$(ela_h_files)

dist_man_MANS += ela/man/explain_syslog.8
dist_man_MANS += ela/man/explain_syslog.8 ela/man/add_regex.8

clean-local-ela:
rm -f $(BUILT_SOURCE)
Expand Down
13 changes: 13 additions & 0 deletions ela/man/add_regex.8
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.TH add_regex: "8" "June 2016" "ppc64-diag" "System Administration Utilities"
.SH NAME
add_regex \- catalog parser
.SH SYNOPSIS
.B add_regex
[\fB\-C\fR \fI\,dir\/\fR]
.SH DESCRIPTION
Parse all the catalog files in the specified directory, populating
reporter_catalog, exceptions catalog, and event_catalog.
.SH OPTIONS
.TP
.BR \-C " " \fIdir\fR
Catalog directory in which catalog files are stored.
3 changes: 2 additions & 1 deletion opal_errd/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ opal_errd_opal_elog_parse_opal_elog_parse_SOURCES = \
opal_errd/opal-elog-parse/print-esel-header.c \
$(opal_elog_parse_h_files)

dist_man_MANS += opal_errd/man/opal-elog-parse.8 opal_errd/man/opal_errd.8
dist_man_MANS += opal_errd/man/opal-elog-parse.8 opal_errd/man/opal_errd.8 \
opal_errd/man/extract_opal_dump.8

EXTRA_DIST += opal_errd/run_tests \
opal_errd/test-extract_opal_dump \
Expand Down
25 changes: 25 additions & 0 deletions opal_errd/extract_opal_dump.8
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.TH extract_opal_dump "8" "June 2016" "ppc64-diag" "System Administration Utilities"
.SH NAME
extract_opal_dump \- Extract opal dump
.SH SYNOPSIS
.B extract_opal_dump
[\fI\,OPTION\/\fR]...
.SH DESCRIPTION
.PP
\fB\-A\fR
Don't acknowledge dump
.TP
\fB\-s\fR \fI\,dir\fR
sysfs directory (default \fI\,/sys\/\fP)
.TP
\fB\-o\fR \fI\,dir\fR
directory to save dumps (default \fI\,/var/log/dump\/\fP)
.TP
\fB\-m\fR \fI\,max\fR
maximum number of dumps of a specific type to be saved
.TP
\fB\-w\fR
wait for a dump
.TP
\fB\-h\fR
help (this message)
3 changes: 2 additions & 1 deletion rtas_errd/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ rtas_errd_rtas_errd_SOURCES = \
rtas_errd_rtas_errd_LDADD = -lrtas -lrtasevent -lservicelog

rtas_scripts = rtas_errd/rc.powerfail
dist_man_MANS += rtas_errd/man/rtas_errd.8
dist_man_MANS += rtas_errd/man/rtas_errd.8 rtas_errd/man/extract_platdump.8 \
rtas_errd/man/convert_dt_node_props.8

install-exec-hook-rtas-errd:
install -d --mode=755 $(DESTDIR)/etc/
Expand Down
16 changes: 16 additions & 0 deletions rtas_errd/convert_dt_node_props.8
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.TH convert_dt_node_props "8" "June 2016" "ppc64-diag" "System Administration Utilities"
.SH NAME
convert_dt_node_props \- conversion tool
.SH SYNOPSIS
.B convert_dt_node_props
\fB\-\-context\fR \fI\,<x>\fR \fB\-\-from \fI\,<y>\fR \fB\-\-to \fI\,<z>\fR \fI\,<value>\/\fR
.SH DESCRIPTION
.HP
\fB\-c\fR, \fB\-\-context\fR: currently, \fI\,<x>\fR must be cpu
.HP
\fB\-f\fR, \fB\-\-from\fR and \fB\-t\fR, \fB\-\-to\fR: allowed values for \fI\,<y>\fR and \fI\,<z>\fR: interrupt\-server, drc\-index, drc\-name
.IP
if \fI\,<value>\fR is a drc\-index or interrupt\-server, it can be
specified in decimal, hex (with a leading 0x), or octal
(with a leading 0); if it is a drc\-name, it should be
specified as a string in double quotes
12 changes: 12 additions & 0 deletions rtas_errd/extract_platdump.8
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.TH extract_platdump "8" "June 2016" "ppc64-diag" "System Administration Utilities"
.SH NAME
extract_platdump: \- Extract platform dump
.SH SYNOPSIS
.B extract_platdump
[\fI\,-h\/\fR] [\fI\,-v\/\fR] \fI\,<dump_tag>\/\fR
.SH DESCRIPTION
Extracts a platform dump with a given tag to the filesystem. \fI\,<dump_tag>\fR is the tag of the dump(s) to extract, in hex.
.HP
\fB\-h\fR: print this help message
.HP
\fB\-v\fR: verbose output