1NYPATCHY(1) General Commands Manual NYPATCHY(1)
2
6 nypatchy - tool to work with specialized-format patches
7
9 nypatchy pam fort cradle print cc as data [ fort2 cc2 as2 data2 ]
10
12 nypatchy is a tool for working with Patchy Master Files (PAM files). A
13 PAM file is an ordinary text file (generally with a three-letter exten‐
14 sion of ".car") that holds source code interleaved with special
15 pre-processing instructions for nypatchy. The source code may be in C,
16 FORTRAN, assembly language, or a combination of these. The pre-pro‐
17 cessing instructions allow one to maintain separate optional patches
18 independently, for instance in the case of architecture-specific code.
19 Details of the pre-processing commands used by nypatchy are beyond the
20 scope of this man page; the reader should refer to the full manual
21 available from CERN.
22 Telling nypatchy which set of patches to use may be done on standard
24 input or via a so-called cradle file. Typically the cradle file will
25 contain one or more +USE statements as well as +EXE and +QUIT, for
26 instance in the case of the isajet Monte Carlo generator:
27 +USE,*ISAJET
29 +EXE
30 +PAM
31 +QUIT
32
34 In the command line shown above, pam is the PAM file, if any. fort is
35 the name of the primary output source code file, if any. cradle is the
36 name of the cradle file, if any (default is standard input, for
37 instance a here-doc). print is the name of the file to receive printed
38 output (the default is standard output). cc, as, data are the names of
39 the source code output files for data types CC, AS, DATA. The remain‐
40 ing parameters are the source code output files to receive diverted
41 material for respective data types FORT, CC, AS, DATA.
42 Parameters may be omitted by substituting a dash - for them. Trailing
44 parameters may be cut short by giving "." or ".go"; the latter com‐
45 mences execution immediately rather than starting the nypatchy interac‐
46 tive prompt.
47 nypatchy will return to the shell a code of 0 if successful, 1 if there
49 is a warning, and 2 if an error occurs. Since the program stops creat‐
50 ing output, but continues to run (in order to check for further errors)
51 if an error occurs, the user should be sure to test the error code $?
52 after any nypatchy run.
53
55 nypatchy -- xyz .go
56 reads the cradle (instructions) from file xyz.cra, which must
57 list all other files to be used.
58 nypatchy .go << EOF
60 <cradle>
61 EOF
63 has the cradle given as a here-document.
64 nypatchy zebra.car zebra.fca zebra.cra zebra.lis .go
66 reads the PAM file zebra.car, outputting the resulting source
67 code to zebra.fca, taking the cradle from zebra.cra, with print‐
68 ing done to zebra.lis.
69
71 fcasplit(1), nycheck(1), nydiff(1), nyindex(1), nylist(1), nymerge(1),
72 nyshell(1), nysynopt(1), nytidy(1), yexpand(1)
73 The reference manual for the Nypatchy suite of programs is available in
75 compressed PostScript format at the following URL:
76 http://wwwasdoc.web.cern.ch/wwwasdoc/psdir/p5refman.ps.gz
77 Running the command "nypatchy help .no" also gives some brief help on
79 usage.
80
82 This manual page was written by Kevin McCarty <kmccarty@debian.org> for
83 the Debian GNU/Linux system (but may be used by others). It is
84 licensed under the GNU General Public License, version 2 or later (at
85 your choice).
86
88 Copyright (C) Kevin B. McCarty, 2008.
89NYPATCHY(1) General Commands Manual NYPATCHY(1)
93
97 nypatchy - tool to work with specialized-format patches
98
100 nypatchy pam fort cradle print cc as data [ fort2 cc2 as2 data2 ]
101
103 nypatchy is a tool for working with Patchy Master Files (PAM files). A
104 PAM file is an ordinary text file (generally with a three-letter exten‐
105 sion of ".car") that holds source code interleaved with special
106 pre-processing instructions for nypatchy. The source code may be in C,
107 FORTRAN, assembly language, or a combination of these. The pre-pro‐
108 cessing instructions allow one to maintain separate optional patches
109 independently, for instance in the case of architecture-specific code.
110 Details of the pre-processing commands used by nypatchy are beyond the
111 scope of this man page; the reader should refer to the full manual
112 available from CERN.
113 Telling nypatchy which set of patches to use may be done on standard
115 input or via a so-called cradle file. Typically the cradle file will
116 contain one or more +USE statements as well as +EXE and +QUIT, for
117 instance in the case of the isajet Monte Carlo generator:
118 +USE,*ISAJET
120 +EXE
121 +PAM
122 +QUIT
123
125 In the command line shown above, pam is the PAM file, if any. fort is
126 the name of the primary output source code file, if any. cradle is the
127 name of the cradle file, if any (default is standard input, for
128 instance a here-doc). print is the name of the file to receive printed
129 output (the default is standard output). cc, as, data are the names of
130 the source code output files for data types CC, AS, DATA. The remain‐
131 ing parameters are the source code output files to receive diverted
132 material for respective data types FORT, CC, AS, DATA.
133 Parameters may be omitted by substituting a dash - for them. Trailing
135 parameters may be cut short by giving "." or ".go"; the latter com‐
136 mences execution immediately rather than starting the nypatchy interac‐
137 tive prompt.
138 nypatchy will return to the shell a code of 0 if successful, 1 if there
140 is a warning, and 2 if an error occurs. Since the program stops creat‐
141 ing output, but continues to run (in order to check for further errors)
142 if an error occurs, the user should be sure to test the error code $?
143 after any nypatchy run.
144
146 nypatchy -- xyz .go
147 reads the cradle (instructions) from file xyz.cra, which must
148 list all other files to be used.
149 nypatchy .go << EOF
151 <cradle>
152 EOF
154 has the cradle given as a here-document.
155 nypatchy zebra.car zebra.fca zebra.cra zebra.lis .go
157 reads the PAM file zebra.car, outputting the resulting source
158 code to zebra.fca, taking the cradle from zebra.cra, with print‐
159 ing done to zebra.lis.
160
162 fcasplit(1), nycheck(1), nydiff(1), nyindex(1), nylist(1), nymerge(1),
163 nyshell(1), nysynopt(1), nytidy(1), yexpand(1)
164 The reference manual for the Nypatchy suite of programs is available in
166 compressed PostScript format at the following URL:
167 http://wwwasdoc.web.cern.ch/wwwasdoc/psdir/p5refman.ps.gz
168 Running the command "nypatchy help .no" also gives some brief help on
170 usage.
171
173 This manual page was written by Kevin McCarty <kmccarty@debian.org> for
174 the Debian GNU/Linux system (but may be used by others). It is
175 licensed under the GNU General Public License, version 2 or later (at
176 your choice).
177
179 Copyright (C) Kevin B. McCarty, 2008.
180 Mar 12, 2008 NYPATCHY(1)