chiark / gitweb /
* summer manpage (thanks to Peter Maydell for initial contribution).
authorianmdlvl <ianmdlvl>
Sat, 22 Sep 2007 00:21:48 +0000 (00:21 +0000)
committerianmdlvl <ianmdlvl>
Sat, 22 Sep 2007 00:21:48 +0000 (00:21 +0000)
cprogs/summer.1
debian/changelog

index c8ddb24..1e829bf 100644 (file)
@@ -2,7 +2,7 @@
 .SH NAME
 summer \- print checksum and system metainformation for files
 .SH SYNOPSIS
-.B summer -ACDbfhqt
+.B summer -ACDbfqtx
 .RI [\| startpoint ...]
 .br
 .SH DESCRIPTION
@@ -31,57 +31,63 @@ Each line has the following columns:
 .TS
 tab (@);
 l l.
-@MD5sum or file type information
+@MD5 checksum (in hex) or file type information
 @Size of file in bytes
 @File access rights (in octal)
-@User ID of owner
-@Group ID of owner
-@atime (time of last access)
+@User ID of owner (in decimal)
+@Group ID of owner (in decimal)
+@atime (time of last access, decimal time_t)
 @mtime (time of last modification)
 @ctime (time of last status change)
 @Filename
 .TE
 
-For regular files, the first column is the MD5sum. For directories, pipes,
-symlinks and sockets it is the literal string `dir', `pipe', `symlink' or `socket'
-as appropriate. For devices it begins with `c' for character or `b' for block
+For regular files, the first column is the md5sum. For directories, pipes,
+symlinks and sockets it is the literal string \fBdir\fR, \fBmountpoint\fR, \fBpipe\fR, \fBsymlink\fR or \fBsocket\fR
+as appropriate. For devices it begins with \fBc\fR for character or \fBb\fR for block
 devices, followed by the device number as a single 32 bit hex number and as
-four separate 8 bit hex numbers.
+four separate 8 bit decimal numbers (most significant first).
 
-Note that certain characters in the filename (including spaces and `\\' characters)
+Note that any bytes in the filename other than printing 7-bit ASCII
 are escaped using
 .B \\\x\c
 .I NN
 syntax, where
 .I NN
-are two hex digits. This makes the output unambiguous. Filenames will be relative
+are two hex digits; backslashes are also escaped in this way.
+This makes the output unambiguous.  Filenames will be relative
 if the relevant
 .I startpoint
 was relative, and absolute if it was absolute.
-For symlinks the filename
-column includes an indication of the target of the link.
+
+For symlinks the filename column is followed by `\fB -> \fR' (note the
+spaces) and the target of the link, again escaped, as above.
 .SH OPTIONS
 .TP
 .B \-A
-Do not print the atime (time of last access). The `atime' column will be omitted.
+Do not print the atime (time of last access). The atime column will be omitted.
 .TP
 .B \-C
-Do not print the ctime (time of last status change). The `ctime' column will be omitted.
+Do not print the ctime (time of last status change). The ctime column will be omitted.
+.TP
+.B \-M
+Do not print the mtime (time of last modification). The mtime column will be omitted.
 .TP
 .B \-D
-Do not print directory sizes. The `size' column for directories will read `dir'.
+Do not print directory sizes. The size column for directories will read \fBdir\fR.
 .TP
 .B \-b
-Do not print mtime (time of last modification) for symbolic links. The `mtime' field
-for symbolic links will read `link'.
+Do not print mtime (time of last modification) for symbolic links. The mtime field
+for symbolic links will read \fBlink\fR.
 .TP
 .B \-f
 Include information about errors encountered (for example, unreadable files)
 in the output, and continue processing. The default is to print error information
 to standard error and stop immediately an error is encountered.
 .TP
-.B \-h
-Print a brief usage message (and do nothing else).
+.B \-x
+Do not cross mountpoints while recursing into subdirectories.  
+Startpoints which are mountpoints \fIare\fR descended into.
 .TP
 .B \-q
 Suppress the progress information which
@@ -91,18 +97,54 @@ normally prints to standard error.
 .B \-t
 Set the field separator between the information and the filename to a
 tab character (default is space).
-.SH BUGS
-.B summer
-requires switches to be specified in a single argument; that is,
-.B -ACf
-is accepted but
-.B -A -C -f
-is not.
+.TP
+.B \-f
+Normally any errors (problems accessing files including nonexistent
+startpoings, and the like) are fatal; an error message is reported to
+stderr.
+
+With
+.B -f
+errors are nonfatal and the problems are reported inline.  The
+filesystem object with the problem is reported in the normal way
+except that instead of the checksum, the string
+\fB\\[\fR\fIproblem\fR[\fB:\fR\ \fIdetails\fR]\fB]\fR
+appears.  Fields whose value could not be determined are printed
+as \fB?\fR.
+.TP
+.B \-h
+Print a brief usage message to stderr (and do nothing else, exiting nonzero).
+.SH PARSING THE OUTPUT
+If the first character in the line is \fB\\[\fR, then the first
+(checksum or type) field is everything until the first subsequent
+\fB]\fR; this may be of variable length and will be followed by one or
+more spaces.  Otherwise the first field has a fixed width: 64
+characters, the size of an MD5 checksum represented in hex, and is
+followed by a single space.
+
+The metadata fields are space-separated but are also space-padded to a
+minimum width: 10 characters for sizes and times and ids; 4 characters
+for the mode.
+
+The filename field, and optional link target information, are of
+variable length, but they are escaped so that they do not contain
+spaces.
 .SH AUTHOR
-This Manual page was written by Peter Maydell <pmaydell@chiark.greenend.org.uk> but
-may be used by anyone.
-.SH COPYRIGHT
-Copyright (C) 2003-2006 Ian Jackson <ian@chiark.greenend.org.uk>
+.B summer
+is
 .br
-This is free software; see the source for copying conditions.  There is NO
+Copyright (C) 2003-2007 Ian Jackson <ian@chiark.greenend.org.uk>
+
+This manpage was written by Peter Maydell
+and subsequently improved by Ian Jackson.  It is
+.br
+Copyright (C) 2006 Peter Maydell <pmaydell@chiark.greenend.org.uk>
+.br
+Copyright (C) 2007 Ian Jackson <ian@chiark.greenend.org.uk>
+
+This is free software, distributed under the GNU General Public
+Licence, version 3 or (at your option) any later version; see
+/usr/share/doc/chiark-utils-bin/copyright or
+/usr/share/common-licenses/GPL-3
+for copying conditions.  There is NO
 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
index b819a92..2623c55 100644 (file)
@@ -10,6 +10,7 @@ chiark-utils (4.1.22) unstable; urgency=low
       areas (since these can't cause problems).  Thanks to Ben Harris
       for report and subsequent discussion.
   * chiark-backup Depends on chiark-utils-bin.  Closes: #401611.
+  * summer manpage (thanks to Peter Maydell for initial contribution).
 
  --