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

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