X-Git-Url: https://git.distorted.org.uk/~mdw/sw-tools/blobdiff_plain/4216aeb54f91dd6bb717a524528e3d7d2b221716..e55daacc8888ea40715a620cf21bef29583a670f:/perl/sw-tidy.1

diff --git a/perl/sw-tidy.1 b/perl/sw-tidy.1
index f7ffeb8..5e6b30a 100644
--- a/perl/sw-tidy.1
+++ b/perl/sw-tidy.1
@@ -1,6 +1,6 @@
 .\" -*-nroff-*-
 .\"
-.\" $Id: sw-tidy.1,v 1.2 2004/04/08 01:52:19 mdw Exp $
+.\" $Id$
 .\"
 .\" Manual page for `sw-tidy'
 .\"
@@ -25,3 +25,67 @@
 .\" along with sw-tools; if not, write to the Free Software Foundation,
 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 .
+.ie \n(.g \{\
+. fam P
+. ds mw \fR[\f(BImdw\fR]
+.\}
+.el .ds mw \fR[\fBmdw\fR]
+.ds sw \fBsw\fP
+.
+.\"----- Main manual text ---------------------------------------------------
+.
+.TH sw-tidy 1 "30 July 1999" sw-tools
+.
+.\"--------------------------------------------------------------------------
+.
+.SH NAME
+.
+sw-tidy \- tidy \fBsw\fP's index file
+.
+.\"--------------------------------------------------------------------------
+.
+.SH "SYNOPSIS"
+.
+.B sw-tidy
+.
+.\"--------------------------------------------------------------------------
+.
+.SH "DESCRIPTION"
+.
+The
+.B sw-tidy
+command reads
+.BR sw (1)'s
+index file
+.IB prefix /sw-index
+and writes out a new version with duplicate packages removed.  This
+makes it take less space, and lets programs read it faster.  Also, as a
+side-effect, the new version is written out in alphabetical order of
+package-name, although that's not very important.
+.PP
+The program copes (a bit) if the index file is written to while it's
+being tidied.
+.
+.\"--------------------------------------------------------------------------
+.
+.SH "BUGS"
+.
+Perhaps there ought to be a locking convention for the index file.
+However, it's nice that people can update it using
+.BR cat (1)
+and text editors.
+.
+.\"--------------------------------------------------------------------------
+.
+.SH "SEE ALSO"
+.
+.BR sw (1),
+.BR sw-info (5).
+.
+.SH "AUTHOR"
+.
+The \*(sw program, and this manual, are \*(mw productions, in association
+with the European Bioinformatics Institute.  They were written by Mark
+Wooding <mdw@nsict.org>.  Go and ask him if you have problems.
+.
+.\"----- That's all, folks --------------------------------------------------