Debian Codegraph @

texmf-dist/doc/man/man1/ctan-o-mat.1

raw
1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 . if \nF \{\
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{\
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
75 .if n \{\
76 . ds #H 0
77 . ds #V .8m
78 . ds #F .3m
79 . ds #[ \f1
80 . ds #] \fP
81 .\}
82 .if t \{\
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 . ds #V .6m
85 . ds #F 0
86 . ds #[ \&
87 . ds #] \&
88 .\}
89 . \" simple accents for nroff and troff
90 .if n \{\
91 . ds ' \&
92 . ds ` \&
93 . ds ^ \&
94 . ds , \&
95 . ds ~ ~
96 . ds /
97 .\}
98 .if t \{\
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 . ds : e
123 . ds 8 ss
124 . ds o a
125 . ds d- d\h'-1'\(ga
126 . ds D- D\h'-1'\(hy
127 . ds th \o'bp'
128 . ds Th \o'LP'
129 . ds ae ae
130 . ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "CTAN-O-MAT 1"
136 .TH CTAN-O-MAT 1 "2017-11-23" "ctan-o-mat" "Gerd Neugebauer"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 ctan\-o\-mat \- Validate and upload a package for CTAN
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 ctan-o-mat [options] [<package configuration>]
146 .SH "DESCRIPTION"
147 .IX Header "DESCRIPTION"
148 This program can be used to automate the upload of a package to the
149 Comprehensive TeX Archive Network (https://www.ctan.org). The description
150 of the package is taken from a configuration file. Thus it can be updated
151 easily without the need to fill a Web form with the same old information
152 again and again.
153 .PP
154 The provided information is validated in any case. If the validation
155 succeeds and not only the validation is requested then the provided
156 archive file is placed in the incoming area of the \s-1CTAN\s0 for further
157 processing by the \s-1CTAN\s0 team.
158 .PP
159 In any case any finding during the validation is reported at the end
160 of the processing. Note that the validation is the default and a
161 official submission has to be requested by the an appropriate command
162 line option.
163 .PP
164 \&\fBctan-o-mat\fR requires an Internet connection to the \s-1CTAN\s0 server. Even the
165 validation retrieves the known attributes and the basic constraints
166 from the server.
167 .SH "CONFIGURATION"
168 .IX Header "CONFIGURATION"
169 The default configuration is read from a file with the same name as
170 the current directory an the extension .pkg. This file name can be
171 overwritten on the command line.
172 .PP
173 The configuration depends on the features currently supported by the
174 \&\s-1CTAN\s0 server.
175 Since these features can change over time the configuration is not
176 hard-coded in \fBctan-o-mat\fR. You can request an empty template of the
177 configuration via the command line parameter \f(CW\*(C`\-\-init\*(C'\fR.
178 .SH "OPTIONS"
179 .IX Header "OPTIONS"
180 .IP "\-h" 4
181 .IX Item "-h"
182 .PD 0
183 .IP "\-\-help" 4
184 .IX Item "--help"
185 .PD
186 Print this short summary about the usage and exit the program.
187 .IP "\-i" 4
188 .IX Item "-i"
189 .PD 0
190 .IP "\-\-init" 4
191 .IX Item "--init"
192 .PD
193 Create an empty template for a configuration.
194 .IP "\-\-list licenses" 4
195 .IX Item "--list licenses"
196 List the known licenses of \s-1CTAN\s0 to the standard output stream.
197 Each license is represented as one line. The line contains the fields
198 key, name, free indicator. Those fields are separated by tab characters.
199 Afterwards the program terminates without processing any further arguments.
200 .IP "\-\-config <package configuration>" 4
201 .IX Item "--config <package configuration>"
202 .PD 0
203 .IP "\-\-pkg <package configuration>" 4
204 .IX Item "--pkg <package configuration>"
205 .IP "\-\-package <package configuration>" 4
206 .IX Item "--package <package configuration>"
207 .PD
208 Set the package configuration file.
209 .IP "\-s" 4
210 .IX Item "-s"
211 .PD 0
212 .IP "\-\-submit" 4
213 .IX Item "--submit"
214 .PD
215 Upload the submission, validate it and officially submit it to \s-1CTAN\s0 it the
216 validation succeeds.
217 .IP "\-v" 4
218 .IX Item "-v"
219 .PD 0
220 .IP "\-\-verbose" 4
221 .IX Item "--verbose"
222 .PD
223 Print some more information during the processing (verbose mode).
224 .IP "\-\-version" 4
225 .IX Item "--version"
226 Print the version number of this program and exit.
227 .IP "\-\-validate" 4
228 .IX Item "--validate"
229 .PD 0
230 .IP "\-n" 4
231 .IX Item "-n"
232 .IP "\-\-noaction" 4
233 .IX Item "--noaction"
234 .PD
235 Do not perform the final upload. The package is validated and the
236 resulting messages are printed.
237 .IP "<package>" 4
238 .IX Item "<package>"
239 This parameter is the name of a package configuration
240 (see section \s-1CONFIGURATION\s0) contained in a file.
241 If not set otherwise the package configuration defaults to the
242 name of the current directory with \f(CW\*(C`.pkg\*(C'\fR appended.
243 .SH "ENVIRONMENT"
244 .IX Header "ENVIRONMENT"
245 The following environment variables are recognized by \fBctan-o-mat\fR.
246 .IP "\s-1CTAN_O_MAT_URL\s0" 4
247 .IX Item "CTAN_O_MAT_URL"
248 The value is the \s-1URL\s0 prefix for the \s-1CTAN\s0 server to be contacted. The default
249 is \f(CW\*(C`https://ctan.org/submit\*(C'\fR. The complete \s-1URL\s0 is constructed by appending
250 \&\f(CW\*(C`validate\*(C'\fR, \f(CW\*(C`upload\*(C'\fR, or \f(CW\*(C`fields\*(C'\fR to use the respective \s-1CTAN REST API.\s0
251 .SH "CONNECTING VIA PROXIES"
252 .IX Header "CONNECTING VIA PROXIES"
253 If you need to connect to the Internet via a proxy then this can be achieved
254 by setting some environment variables before running \fBctan-o-mat\fR.
255 To redirect the request via the proxy simply define an environment variable
256 \&\f(CW\*(C`http_proxy\*(C'\fR to point to the proxy host \*(-- including protocol and port as
257 required. Note that the name of the environment variable is supposed to be in
258 \&\fBlower\fR case.
259 .SH "AUTHOR"
260 .IX Header "AUTHOR"
261 Gerd Neugebauer (gene@gerd\-neugebauer.de)
262 .SH "BUGS"
263 .IX Header "BUGS"
264 .IP "\(bu" 4
265 The program can not be used without a working connection to the
266 Internet.