mdw@git.distorted.org.uk Git - sw-tools/blob - perl/sw-tidy.1

   1 .\" -*-nroff-*-
   2 .\"
   3 .\" $Id$
   4 .\"
   5 .\" Manual page for `sw-tidy'
   6 .\"
   7 .\" (c) 1999 EBI
   8 .\"
   9 .
  10 .\"----- Licensing notice ---------------------------------------------------
  11 .\"
  12 .\" This file is part of sw-tools.
  13 .\"
  14 .\" sw-tools is free software; you can redistribute it and/or modify
  15 .\" it under the terms of the GNU General Public License as published by
  16 .\" the Free Software Foundation; either version 2 of the License, or
  17 .\" (at your option) any later version.
  18 .\"
  19 .\" sw-tools is distributed in the hope that it will be useful,
  20 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 .\" GNU General Public License for more details.
  23 .\"
  24 .\" You should have received a copy of the GNU General Public License
  25 .\" along with sw-tools; if not, write to the Free Software Foundation,
  26 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27 .
  28 .ie \n(.g \{\
  29 . fam P
  30 . ds mw \fR[\f(BImdw\fR]
  31 .\}
  32 .el .ds mw \fR[\fBmdw\fR]
  33 .ds sw \fBsw\fP
  34 .
  35 .\"----- Main manual text ---------------------------------------------------
  36 .
  37 .TH sw-tidy 1 "30 July 1999" sw-tools
  38 .
  39 .\"--------------------------------------------------------------------------
  40 .
  41 .SH NAME
  42 .
  43 sw-tidy \- tidy \fBsw\fP's index file
  44 .
  45 .\"--------------------------------------------------------------------------
  46 .
  47 .SH "SYNOPSIS"
  48 .
  49 .B sw-tidy
  50 .
  51 .\"--------------------------------------------------------------------------
  52 .
  53 .SH "DESCRIPTION"
  54 .
  55 The
  56 .B sw-tidy
  57 command reads
  58 .BR sw (1)'s
  59 index file
  60 .IB prefix /sw-index
  61 and writes out a new version with duplicate packages removed.  This
  62 makes it take less space, and lets programs read it faster.  Also, as a
  63 side-effect, the new version is written out in alphabetical order of
  64 package-name, although that's not very important.
  65 .PP
  66 The program copes (a bit) if the index file is written to while it's
  67 being tidied.
  68 .
  69 .\"--------------------------------------------------------------------------
  70 .
  71 .SH "BUGS"
  72 .
  73 Perhaps there ought to be a locking convention for the index file.
  74 However, it's nice that people can update it using
  75 .BR cat (1)
  76 and text editors.
  77 .
  78 .\"--------------------------------------------------------------------------
  79 .
  80 .SH "SEE ALSO"
  81 .
  82 .BR sw (1),
  83 .BR sw-info (5).
  84 .
  85 .SH "AUTHOR"
  86 .
  87 The \*(sw program, and this manual, are \*(mw productions, in association
  88 with the European Bioinformatics Institute.  They were written by Mark
  89 Wooding <mdw@nsict.org>.  Go and ask him if you have problems.
  90 .
  91 .\"----- That's all, folks --------------------------------------------------