docs: format, grammarize, and standardize the wall man page

[thirdparty/util-linux.git] / login-utils / utmpdump.1

'\" -*- coding: UTF-8 -*-
.\" Copyright (C) 2010 Michael Krapp
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by 
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
.\"
.TH UTMPDUMP "1" "July 2012" "util-linux" "System Administration"
.SH NAME
utmpdump \- dump UTMP and WTMP files in raw format
.SH SYNOPSIS
utmpdump [\-frohV] [ filename ]
.SH DESCRIPTION
.B utmpdump
is a simple program to dump UTMP and WTMP files in raw format, so they
can be examined.
.B utmpdump
eads from stdin unless a 
.I filename
is passed.
.SH OPTIONS
.IP "\fB\-f\fR, \fB\-\-follow\fP"
Output appended data as the file grows.
.IP "\fB\-r\fR, \fB\-\-reverse\fP
Undump, write back edited login information into utmp or wtmp files.
.IP "\fB\-o\fR, \fB\-\-output\fP \fIfile\fR
Write command output to file instead of standard output.
.IP "\fB\-h\fR, \fB\-\-help\fP"
Print a help text and exit.
.IP "\fB\-V\fR, \fB\-\-version\fP"
Output version information and exit.
.SH NOTES
.B utmpdump
can be useful in cases of corrupted utmp or wtmp entries.  It can dump
out utmp/wtmp to an ASCII file, then that file can be edited to remove
bogus entries and reintegrated, using
.PP 
.RS
utmpdump -r < ascii_file > wtmp
.RE
.PP
but be warned as
.B utmpdump
was written for debugging purpose only.
.SH BUGS
You may
.B not
use the option
.B \-r
as the format for the utmp/wtmp files strongly depends on the input
format.  This tool was
.B not
written for normal use but for debugging.
.SH AUTHOR
Michael Krapp
.SH "SEE ALSO"
.BR last (1),
.BR w (1),
.BR who (1),
.BR utmp (5)
.SH AVAILABILITY
The utmpdump command is part of the util-linux package and is available
from
.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
Linux Kernel Archive
.UE .