summaryrefslogtreecommitdiff
path: root/support/ctanupload/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/ctanupload/README
Initial commit
Diffstat (limited to 'support/ctanupload/README')
-rw-r--r--support/ctanupload/README69
1 files changed, 69 insertions, 0 deletions
diff --git a/support/ctanupload/README b/support/ctanupload/README
new file mode 100644
index 0000000000..8554fc7a0b
--- /dev/null
+++ b/support/ctanupload/README
@@ -0,0 +1,69 @@
+ctanupload script
+~~~~~~~~~~~~~~~~~
+This Perl script allows the uploads of a contribution to CTAN from the command line.
+It is intended to simplify the release process for LaTeX package authors.
+
+Copyright (C) by Martin Scharrer <martin@scharrer-online.de>
+Source code repository: https://bitbucket.org/martin_scharrer/ctanupload
+Please report bugs and feature requests at https://bitbucket.org/martin_scharrer/ctanupload/issues/
+
+Usage:
+ctanupload <options> --<name>=<value>
+
+Arguments can also be given using the CTANUPLOAD environment variable which are processed first, so that
+explicit arguments will overwrite them.
+
+Options:
+ -p Prompt for missing values. (default if run in terminal)
+ -P Do not prompt for missing values. (default if not run in terminal)
+ -y Do not ask for confirmation, but submit immediately.
+ -u <URL> CTAN URL to upload to (defaults to CTAN_URL environment variable or random if not set)
+ -U <name> CTAN server to upload to, either 'dante' or 'uktug'.
+ -F <file> Read data from file
+ -f Force upload even if input seems incorrect (unknown license etc.).
+ -v Verbose mode.
+ -q Quiet mode.
+ -l Write log file.
+ -L Do not write log file. (default)
+ -o <file> Define log file. (still requires -l)
+ -h Print this help and exit.
+ -V Print version number.
+
+The following fields exists and can be given as
+--<name>=<value>, --<name> <value>, --<name>-file=<file>, --<name>-file <file>
+or as environment variables: CTAN_<NAME>, CTAN_<name>, <NAME> or <name>.
+
+ contribution Name of your contribution
+ version Version number
+ name Your name
+ email Your email
+ summary Summary description
+ directory Suggested CTAN directory
+ DoNotAnnounce No need to announce this update
+ announce Short description for announcement
+ notes Optional notes to the CTAN maintainers
+ license License type
+ freeversion Which free license
+ file File to upload
+
+Valid license types:
+ free Free
+ nocommercial Nocommercial
+ nosell Nosell
+ nosource Nosource
+ shareware Shareware
+ artistic Perl Artistic (Clarified or later)
+ other-nonfree Other nonfree License
+
+Valid free license:
+ apache2 Apache License v2.0
+ artistic Perl Artistic License (version 2)
+ fdl GNU Free Documentation License
+ gfl GUST Font License
+ gpl GNU General Public License
+ lgpl Lesser GPL
+ lppl LaTeX Project
+ ofl Open Font License
+ pd Public Domain
+ other-free Other Free
+