1CTAN-O-MAT(1) Gerd Neugebauer CTAN-O-MAT(1)
2
6 ctan-o-mat - Validate and upload a package for CTAN
7
9 ctan-o-mat [options] [<package configuration>]
10
12 This program can be used to automate the upload of a package to the
13 Comprehensive TeX Archive Network (https://www.ctan.org). The
14 description of the package is taken from a configuration file. Thus it
15 can be updated easily without the need to fill a Web form with the same
16 old information again and again.
17 The provided information is validated in any case. If the validation
19 succeeds and not only the validation is requested then the provided
20 archive file is placed in the incoming area of the CTAN for further
21 processing by the CTAN team.
22 In any case any finding during the validation is reported at the end of
24 the processing. Note that the validation is the default and a official
25 submission has to be requested by the an appropriate command line
26 option.
27 ctan-o-mat requires an Internet connection to the CTAN server. Even the
29 validation retrieves the known attributes and the basic constraints
30 from the server.
31
33 The default configuration is read from a file with the same name as the
34 current directory an the extension .pkg. This file name can be
35 overwritten on the command line.
36 The configuration depends on the features currently supported by the
38 CTAN server. Since these features can change over time the
39 configuration is not hard-coded in ctan-o-mat. You can request an empty
40 template of the configuration via the command line parameter "--init".
41
43 -h
44 --help
45 Print this short summary about the usage and exit the program.
46 -i
48 --init
49 Create an empty template for a configuration.
50 --list licenses
52 List the known licenses of CTAN to the standard output stream.
53 Each license is represented as one line. The line contains the
54 fields key, name, free indicator. Those fields are separated by tab
55 characters. Afterwards the program terminates without processing
56 any further arguments.
57 --config <package configuration>
59 --pkg <package configuration>
60 --package <package configuration>
61 Set the package configuration file.
62 -s
64 --submit
65 Upload the submission, validate it and officially submit it to CTAN
66 it the validation succeeds.
67 -v
69 --verbose
70 Print some more information during the processing (verbose mode).
71 --version
73 Print the version number of this program and exit.
74 --validate
76 -n
77 --noaction
78 Do not perform the final upload. The package is validated and the
79 resulting messages are printed.
80 <package>
82 This parameter is the name of a package configuration (see section
83 CONFIGURATION) contained in a file. If not set otherwise the
84 package configuration defaults to the name of the current directory
85 with ".pkg" appended.
86
88 The following environment variables are recognized by ctan-o-mat.
89 CTAN_O_MAT_URL
91 The value is the URL prefix for the CTAN server to be contacted.
92 The default is "https://ctan.org/submit". The complete URL is
93 constructed by appending "validate", "upload", or "fields" to use
94 the respective CTAN REST API.
95
97 If you need to connect to the Internet via a proxy then this can be
98 achieved by setting some environment variables before running ctan-o-
99 mat. To redirect the request via the proxy simply define an
100 environment variable "http_proxy" to point to the proxy host --
101 including protocol and port as required. Note that the name of the
102 environment variable is supposed to be in lower case.
103
105 Gerd Neugebauer (gene@gerd-neugebauer.de)
106
108 • The program can not be used without a working connection to the
109 Internet.
110ctan-o-mat 2017-11-23 CTAN-O-MAT(1)