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