summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/ctan-o-mat/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/ctan-o-mat/README.md')
-rw-r--r--Master/texmf-dist/doc/support/ctan-o-mat/README.md113
1 files changed, 75 insertions, 38 deletions
diff --git a/Master/texmf-dist/doc/support/ctan-o-mat/README.md b/Master/texmf-dist/doc/support/ctan-o-mat/README.md
index 964d1690ac2..08b44507d4d 100644
--- a/Master/texmf-dist/doc/support/ctan-o-mat/README.md
+++ b/Master/texmf-dist/doc/support/ctan-o-mat/README.md
@@ -1,4 +1,4 @@
-# ctan-o-mat - Upload or validate a package for CTAN
+# ctan-o-mat - Validate and upload a package for CTAN
## SYNOPSIS
@@ -8,10 +8,11 @@ ctan-o-mat [options] [<package configuration>]
## DESCRIPTION
-This program can be used to automate the upload of a package to CTAN
-(https://www.ctan.org). The description of the package is contained in
-a configuration file. Thus it can be updated easily without the need
-to fill a Web form with the same old information.
+This program can be used to automate the upload of a package to the
+Comprehensive TeX Archive Network (https://www.ctan.org). The
+description of the package is taken from a configuration file. Thus it
+can be updated easily without the need to fill a Web form with the
+same old information again and again.
The provided information is validated in any case. If the validation
succeeds and not only the validation is requested then the provided
@@ -23,9 +24,9 @@ of the processing. Note that the validation is the default and a
official submission has to be requested by the an appropriate command
line option.
-*ctan-o-mat* requires an Internet connection to the CTAN server. Even the
-validation retrieves the known attributes and the basic constraints
-from the server.
+*ctan-o-mat* requires an Internet connection to the CTAN server. Even
+the validation retrieves the known attributes and the basic
+constraints from the server.
## CONFIGURATION
@@ -34,10 +35,10 @@ The default configuration is read from a file with the same name as
the current directory an the extension `.pkg`. This file name can be
overwritten on the command line.
-The configuration depends on the features supported by the CTAN server.
-Since these features can change over time the configuration is not
-hard-coded in *ctan-o-mat*. You can request a template of the
-configuration via the command line parameter `-init`.
+The configuration depends on the features currently supported by the CTAN
+server. Since these features can change over time the configuration is
+not hard-coded in *ctan-o-mat*. You can request an empty template of the
+configuration via the command line parameter `--init`.
## OPTIONS
@@ -49,21 +50,11 @@ configuration via the command line parameter `-init`.
Print this short summary about the usage and exit the program.
</dd>
- <dt><code>--validate</code></dt>
- <dt><code>-n</code></dt>
- <dt><code>--noaction</code></dt>
- <dd>
- Do not perform the final upload. The package is validated and the
- resulting messages are printed.
- </dd>
-
- <dt><code>-i</code></dt>
<dt><code>--init</code></dt>
<dd>
Create an empty template for a configuration.
</dd>
- <dt><code>-s</code></dt>
<dt><code>--submit</code></dt>
<dd>
Upload the submission, validate it and officially submit it to
@@ -76,39 +67,62 @@ configuration via the command line parameter `-init`.
Print some more information during the processing (verbose mode).
</dd>
- <dt><code>--version</code></dt>
+ <dt><code>--validate</code></dt>
<dd>
- Print the version number of this program and exit.
- </dd>
+ Do not perform the final upload. The package is validated and the
+ resulting messages are printed. This is the default.
+ </dd>
- <dt><code>--validate</code></dt>
+ <dt><code>--verbose</code></dt>
<dd>
Print some additional debugging information.
</dd>
- <dt>&lt;package&gt;</dt>
+ <dt><code>--version</code></dt>
+ <dd>
+ Print the version number of this program and exit.
+ </dd>
+
+ <dt><code>&lt;package&gt;</code></dt>
<dd>
This parameter is the name of a package configuration
(see section CONFIGURATION) contained in a file.
+ If not set otherwise the package configuration defaults to the
+ name of the current directory with <code>.pkg</code> appended.
+ </dd>
+</dl>
+
+## ENVIRONMENT
+
+The following environment variables are recognized by B<ctan-o-mat>.
+
+<dl>
+ <dt>CTAN_O_MAT_URL</dt>
+ <dd>
+ The value is the URL prefix for the CTAN server to be contacted. The
+ default is `https://ctan.org/submit`. The complete URL is constructed
+ by appending `validate`, `upload`, or `fields` to use the respective
+ CTAN REST API.
</dd>
</dl>
## CONNECTING VIA PROXIES
-If you need to connect to the Internet via a proxy then this can be achieved
-by setting some environment variables before running *ctan-o-mat*.
-To redirect the request via the proxy simply define an environment variable
-`http_proxy` to point to the proxy host -- including protocol and port as
-required. Note that the name of the environment variable is supposed to be in *lower* case.
+If you need to connect to the Internet via a proxy then this can be
+achieved by setting some environment variables before running
+*ctan-o-mat*. To redirect the request via the proxy simply define an
+environment variable `http_proxy` to point to the proxy host --
+including protocol and port as required. Note that the name of the
+environment variable is supposed to be in *lower* case.
## INSTALLATION
### PREREQUISITE: PERL
-*ctan-o-mat* is written in Perl. Thus a Perl interpreter has to be installed,
-at least in version 5. It is assumed that the Perl interpreter is reachable
-under the name `perl` on the program path.
+*ctan-o-mat* is written in Perl. Thus a Perl interpreter has to be
+installed, at least in version 5. It is assumed that the Perl
+interpreter is reachable under the name `perl` on the program path.
### PREREQUISITE: LWP
@@ -121,14 +135,37 @@ the following command line:
perl -MCPAN -e 'install Bundle::LWP'
```
-You might want to check whether LWP can be installed with your package manager. In this case this is the preferred way.
+You might want to check whether LWP can be installed with your package
+manager. In this case this is the preferred way.
### INSTALLATION STEPS
-The installation is straight forward. Just put the file `ctan-o-mat.pl` and one of `ctan-o-mat` or `ctan-o-mat.bat` on your path.
+The installation is straight forward. Just put the file
+`ctan-o-mat.pl` and one of `ctan-o-mat` or `ctan-o-mat.bat` on your
+path.
+
+Make sure that these files are executable (if required). Now you are
+done.
+
+### CREATING THE DOCUMENTATION
+
+The PDF documentation is generated from the file `README.md`. This can
+be done with the following command:
+
+```
+make ctan-o-mat.pdf
+```
+
+It requires Perl and a TeX distribution to be installed and on the
+path.
+
+
+## REPOSITORY
-Make sure that these files are executable (if required). Now you are done.
+*ctan-o-mat* lives in a public repository at GitHub. It can be found under the
+URL https://github.com/ge-ne/ctan-o-mat.
+*ctan-o-mat* can be found on CTAN under the URL https://www.ctan.org/pkg/ctan-o-mat.
## AUTHOR