mdw@git.distorted.org.uk Git - sw-tools/blob - sw-info.5

   1 .\" -*-nroff-*-
   2 .\"
   3 .\" $Id$
   4 .\"
   5 .\" Manual page for `sw-info' files.
   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 .\"----- Style hacking ------------------------------------------------------
  29 .
  30 .de VS \" Start a sort-of verbatim block
  31 .sp 1
  32 .in +5n
  33 .nf
  34 .ft B
  35 ..
  36 .de VE \" Stop a sort-of verbatim block
  37 .ft R
  38 .fi
  39 .in -5n
  40 .sp 1
  41 ..
  42 .de hP \" Start an indented paragraph with a bold right-aligned label
  43 .IP
  44 \fB\h'-\w'\\$1\ 'u'\\$1\ \fP\c
  45 ..
  46 .
  47 .ie \n(.g \{\
  48 .       fam P
  49 .       ds mw \fR[\f(BImdw\fR]
  50 .\}
  51 .el     .ds mw \fR[\fBmdw\fR]
  52 .ie t   .ds o \(bu
  53 .el     .ds o o
  54 .ds sw \fBsw\fP
  55 .ds se \fBsw\-env\fP
  56 .
  57 .\"----- Main manual text ---------------------------------------------------
  58 .
  59 .TH sw-info 5 "25 May 1999" sw-tools
  60 .PD 1
  61 .
  62 .\"--------------------------------------------------------------------------
  63 .
  64 .SH "NAME"
  65 .
  66 sw-info \- description of sw data files
  67 .
  68 .\"--------------------------------------------------------------------------
  69 .
  70 .SH "DESCRIPTION"
  71 .
  72 The
  73 .B .sw\-info
  74 file contains blank lines, comment lines, and assignments.  A blank line
  75 contains only whitespace; a comment line has a
  76 .RB ` # '
  77 as its first non-whitespace character: both are ignored.  An assignment
  78 has the form
  79 .sp 1
  80 .in +5n
  81 .I name
  82 .RB [ = ]
  83 .I value
  84 .in -5n
  85 .sp 1
  86 where
  87 .I name
  88 is one of the field names described below, and
  89 .I value
  90 is any text which doesn't contain newlines, semicolons or null bytes.
  91 Any leading whitespace is stripped; trailing and internal space is
  92 preserved.
  93 .PP
  94 The fields available are:
  95 .TP
  96 .B package
  97 The package's name.
  98 .TP
  99 .B version
 100 The version number of the package.
 101 .TP
 102 .B maintainer
 103 The user name of the package's local maintainer.
 104 .TP
 105 .B date
 106 The date at which this package was last modified by \*(sw, in the form
 107 .IB YYYY \- MM \- DD\fR.
 108 .TP
 109 .B only\-arch
 110 The current architecture restriction.  The architecture names are
 111 separated by commas or spaces (or both).  This field is omitted if there
 112 is no restriction in force.
 113 .TP
 114 .B arch
 115 Successfully built architectures.  The architecture names are separated
 116 by commas or spaces (or both).
 117 .PP
 118 The
 119 .B sw\-index
 120 file consists of a number of entries, one per line.  Comments and blank
 121 lines are not allowed.  Each line contains assignments for a particular
 122 package, separated by semicolons rather than newlines.
 123 .
 124 .\"--------------------------------------------------------------------------
 125 .
 126 .SH "SEE ALSO"
 127 .
 128 .BR sw (1).
 129 .
 130 .SH "AUTHOR"
 131 .
 132 The \*(sw program, and this manual, are \*(mw productions, in association
 133 with the European Bioinformatics Institute.  They were written by Mark
 134 Wooding <mdw@nsict.org>.  Go and ask him if you have problems.
 135 .
 136 .\"----- That's all, folks --------------------------------------------------