X-Git-Url: https://git.distorted.org.uk/~mdw/sw-tools/blobdiff_plain/4216aeb54f91dd6bb717a524528e3d7d2b221716..e55daacc8888ea40715a620cf21bef29583a670f:/sw-info.5

diff --git a/sw-info.5 b/sw-info.5
index e69de29..3e1b073 100644
--- a/sw-info.5
+++ b/sw-info.5
@@ -0,0 +1,136 @@
+.\" -*-nroff-*-
+.\"
+.\" $Id$
+.\"
+.\" Manual page for `sw-info' files.
+.\"
+.\" (c) 1999 EBI
+.\"
+.
+.\"----- Licensing notice ---------------------------------------------------
+.\"
+.\" This file is part of sw-tools.
+.\"
+.\" sw-tools is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\" 
+.\" sw-tools is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\" 
+.\" You should have received a copy of the GNU General Public License
+.\" along with sw-tools; if not, write to the Free Software Foundation,
+.\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+.
+.\"----- Style hacking ------------------------------------------------------
+.
+.de VS \" Start a sort-of verbatim block
+.sp 1
+.in +5n
+.nf
+.ft B
+..
+.de VE \" Stop a sort-of verbatim block
+.ft R
+.fi
+.in -5n
+.sp 1
+..
+.de hP \" Start an indented paragraph with a bold right-aligned label
+.IP
+\fB\h'-\w'\\$1\ 'u'\\$1\ \fP\c
+..
+.
+.ie \n(.g \{\
+.	fam P
+.	ds mw \fR[\f(BImdw\fR]
+.\}
+.el     .ds mw \fR[\fBmdw\fR]
+.ie t   .ds o \(bu
+.el     .ds o o
+.ds sw \fBsw\fP
+.ds se \fBsw\-env\fP
+.
+.\"----- Main manual text ---------------------------------------------------
+.
+.TH sw-info 5 "25 May 1999" sw-tools
+.PD 1
+.
+.\"--------------------------------------------------------------------------
+.
+.SH "NAME"
+.
+sw-info \- description of sw data files
+.
+.\"--------------------------------------------------------------------------
+.
+.SH "DESCRIPTION"
+.
+The
+.B .sw\-info
+file contains blank lines, comment lines, and assignments.  A blank line
+contains only whitespace; a comment line has a
+.RB ` # '
+as its first non-whitespace character: both are ignored.  An assignment
+has the form
+.sp 1
+.in +5n
+.I name
+.RB [ = ]
+.I value
+.in -5in
+.sp 1
+where
+.I name
+is one of the field names described below, and
+.I value
+is any text which doesn't contain newlines, semicolons or null bytes.
+Any leading whitespace is stripped; trailing and internal space is
+preserved.
+.PP
+The fields available are:
+.TP
+.B package
+The package's name.
+.TP
+.B version
+The version number of the package.
+.TP
+.B maintainer
+The user name of the package's local maintainer.
+.TP
+.B date
+The date at which this package was last modified by \*(sw, in the form
+.IB YYYY \- MM \- DD\fR.
+.TP
+.B only\-arch
+The current architecture restriction.  The architecture names are
+separated by commas or spaces (or both).  This field is omitted if there
+is no restriction in force.
+.TP
+.B arch
+Successfully built architectures.  The architecture names are separated
+by commas or spaces (or both).
+.PP
+The
+.B sw\-index
+file consists of a number of entries, one per line.  Comments and blank
+lines are not allowed.  Each line contains assignments for a particular
+package, separated by semicolons rather than newlines.
+.
+.\"--------------------------------------------------------------------------
+.
+.SH "SEE ALSO"
+.
+.BR sw (1).
+.
+.SH "AUTHOR"
+.
+The \*(sw program, and this manual, are \*(mw productions, in association
+with the European Bioinformatics Institute.  They were written by Mark
+Wooding <mdw@nsict.org>.  Go and ask him if you have problems.
+.
+.\"----- That's all, folks --------------------------------------------------