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

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