summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/ctanupload/README
blob: 8554fc7a0bd9f1242f8d3dd7793dd4f040689bc9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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