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

   1 .\" -*-nroff-*-
   2 .\"
   3 .\" $Id: sw-tidy.1,v 1.1 1999/07/30 18:48:16 mdw Exp $
   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 .\"----- Revision history ---------------------------------------------------
  29 .\"
  30 .\" $Log: sw-tidy.1,v $
  31 .\" Revision 1.1  1999/07/30 18:48:16  mdw
  32 .\" Tidy up the software index file.
  33 .\"
  34 .
  35 .ie \n(.g \{\
  36 . fam P
  37 . ds mw \fR[\f(BImdw\fR]
  38 .\}
  39 .el .ds mw \fR[\fBmdw\fR]
  40 .ds sw \fBsw\fP
  41 .
  42 .\"----- Main manual text ---------------------------------------------------
  43 .
  44 .TH sw-tidy 1 "30 July 1999" sw-tools
  45 .
  46 .\"--------------------------------------------------------------------------
  47 .
  48 .SH NAME
  49 .
  50 sw-tidy \- tidy \fBsw\fP's index file
  51 .
  52 .\"--------------------------------------------------------------------------
  53 .
  54 .SH "SYNOPSIS"
  55 .
  56 .B sw-tidy
  57 .
  58 .\"--------------------------------------------------------------------------
  59 .
  60 .SH "DESCRIPTION"
  61 .
  62 The
  63 .B sw-tidy
  64 command reads
  65 .BR sw (1)'s
  66 index file
  67 .IB prefix /sw-index
  68 and writes out a new version with duplicate packages removed.  This
  69 makes it take less space, and lets programs read it faster.  Also, as a
  70 side-effect, the new version is written out in alphabetical order of
  71 package-name, although that's not very important.
  72 .PP
  73 The program copes (a bit) if the index file is written to while it's
  74 being tidied.
  75 .
  76 .\"--------------------------------------------------------------------------
  77 .
  78 .SH "BUGS"
  79 .
  80 Perhaps there ought to be a locking convention for the index file.
  81 However, it's nice that people can update it using
  82 .BR cat (1)
  83 and text editors.
  84 .
  85 .\"--------------------------------------------------------------------------
  86 .
  87 .SH "SEE ALSO"
  88 .
  89 .BR sw (1),
  90 .BR sw-info (5).
  91 .
  92 .SH "AUTHOR"
  93 .
  94 The \*(sw program, and this manual, are \*(mw productions, in association
  95 with the European Bioinformatics Institute.  They were written by Mark
  96 Wooding <mdw@nsict.org>.  Go and ask him if you have problems.
  97 .
  98 .\"----- That's all, folks --------------------------------------------------