[sw-tools] / sw-info.5

.\" -*-nroff-*-
.\"
.\" $Id: sw-info.5,v 1.1 1999/06/04 13:56:18 mdw Exp $
.\"
.\" 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.
.\"
.\"----- Revision history ---------------------------------------------------
.\"
.\" $Log: sw-info.5,v $
.\" Revision 1.1  1999/06/04 13:56:18  mdw
.\" New manual page.
.\"
.\"
.\" --- Useful macro definitions ---
.\"
.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
..
.\"
.\" --- Style hacking ---
.\"
.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 1 "25 May 1999" "EBI 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 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.
Commit	Line	Data
e45f5509	1	.\" --nroff--
	2	.\"
	3	.\" $Id: sw-info.5,v 1.1 1999/06/04 13:56:18 mdw Exp $
	4	.\"
	5	.\" Manual page for `sw-info' files.
	6	.\"
	7	.\" (c) 1999 EBI
	8	.\"
	9	.\"----- Licensing notice ---------------------------------------------------
	10	.\"
	11	.\" This file is part of sw-tools.
	12	.\"
	13	.\" sw-tools is free software; you can redistribute it and/or modify
	14	.\" it under the terms of the GNU General Public License as published by
	15	.\" the Free Software Foundation; either version 2 of the License, or
	16	.\" (at your option) any later version.
	17	.\"
	18	.\" sw-tools is distributed in the hope that it will be useful,
	19	.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
	20	.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	21	.\" GNU General Public License for more details.
	22	.\"
	23	.\" You should have received a copy of the GNU General Public License
	24	.\" along with sw-tools; if not, write to the Free Software Foundation,
	25	.\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	26	.\"
	27	.\"----- Revision history ---------------------------------------------------
	28	.\"
	29	.\" $Log: sw-info.5,v $
	30	.\" Revision 1.1 1999/06/04 13:56:18 mdw
	31	.\" New manual page.
	32	.\"
	33	.\"
	34	.\" --- Useful macro definitions ---
	35	.\"
	36	.de VS \" Start a sort-of verbatim block
	37	.sp 1
	38	.in +5n
	39	.nf
	40	.ft B
	41	..
	42	.de VE \" Stop a sort-of verbatim block
	43	.ft R
	44	.fi
	45	.in -5n
	46	.sp 1
	47	..
	48	.de HP \" Start an indented paragraph with a bold right-aligned label
	49	.IP
	50	\fB\h'-\w'\\$1\ 'u'\\$1\ \fP\c
	51	..
	52	.\"
	53	.\" --- Style hacking ---
	54	.\"
	55	.ie \n(.g \{\
	56	. fam P
	57	. ds mw \fR[\f(BImdw\fR]
	58	.\}
	59	.el .ds mw \fR[\fBmdw\fR]
	60	.ie t .ds o \(bu
	61	.el .ds o o
	62	.ds sw \fBsw\fP
	63	.ds se \fBsw\-env\fP
	64	.\"
65	.\" --- Main manual text ---
66	.\"
67	.TH sw 1 "25 May 1999" "EBI tools"
68	.PD 1
69	.\"
70	.SH NAME
71	sw-info \- description of sw data files
72	.\"
73	.SH DESCRIPTION
74	The
75	.B .sw\-info
76	file contains blank lines, comment lines, and assignments. A blank line
77	contains only whitespace; a comment line has a
78	.RB ` # '
79	as its first non-whitespace character: both are ignored. An assignment
80	has the form
81	.sp 1
82	.in +5n
83	.I name
84	.RB [ = ]
85	.I value
86	.in -5in
87	.sp 1
88	where
89	.I name
90	is one of the field names described below, and
91	.I value
92	is any text which doesn't contain newlines, semicolons or null bytes.
93	Any leading whitespace is stripped; trailing and internal space is
94	preserved.
95	.PP
96	The fields available are:
97	.TP
98	.B package
99	The package's name.
100	.TP
101	.B version
102	The version number of the package.
103	.TP
104	.B maintainer
105	The user name of the package's local maintainer.
106	.TP
107	.B date
108	The date at which this package was last modified by \*(sw, in the form
109	.IB YYYY \- MM \- DD\fR.
110	.TP
111	.B only\-arch
112	The current architecture restriction. The architecture names are
113	separated by commas or spaces (or both). This field is omitted if there
114	is no restriction in force.
115	.TP
116	.B arch
117	Successfully built architectures. The architecture names are separated
118	by commas or spaces (or both).
119	.PP
120	The
121	.B sw\-index
122	file consists of a number of entries, one per line. Comments and blank
123	lines are not allowed. Each line contains assignments for a particular
124	package, separated by semicolons rather than newlines.
125	.SH AUTHOR
126	The \(sw program, and this manual, are \(mw productions, in association
127	with the European Bioinformatics Institute. They were written by Mark
128	Wooding <mdw@nsict.org>. Go and ask him if you have problems.