From 26bbe6fbf6f01b0ad3162a5d7c2cc0a6fbaafc13 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 16 Nov 2017 22:15:27 +0000 Subject: ctan-o-mat (16nov17) git-svn-id: svn://tug.org/texlive/trunk@45834 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/man/man1/ctan-o-mat.1 | 58 +++++++++++++++++++---------- 1 file changed, 38 insertions(+), 20 deletions(-) (limited to 'Master/texmf-dist/doc/man/man1/ctan-o-mat.1') diff --git a/Master/texmf-dist/doc/man/man1/ctan-o-mat.1 b/Master/texmf-dist/doc/man/man1/ctan-o-mat.1 index db9f74aa7a6..30dff2d7c45 100644 --- a/Master/texmf-dist/doc/man/man1/ctan-o-mat.1 +++ b/Master/texmf-dist/doc/man/man1/ctan-o-mat.1 @@ -129,22 +129,23 @@ .\" ======================================================================== .\" .IX Title "CTAN-O-MAT 1" -.TH CTAN-O-MAT 1 "2017-10-20" "ctan-o-mat" "Gerd Neugebauer" +.TH CTAN-O-MAT 1 "2017-11-16" "ctan-o-mat" "Gerd Neugebauer" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" -ctan\-o\-mat \- Upload or validate a package for CTAN +ctan\-o\-mat \- Validate and upload a package for CTAN .SH "SYNOPSIS" .IX Header "SYNOPSIS" ctan-o-mat [options] [] .SH "DESCRIPTION" .IX Header "DESCRIPTION" -This program can be used to automate the upload of a package to \s-1CTAN\s0 -(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. .PP The provided information is validated in any case. If the validation succeeds and not only the validation is requested then the provided @@ -165,10 +166,11 @@ 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. .PP -The configuration depends on the features supported by the \s-1CTAN\s0 server. +The configuration depends on the features currently supported by the +\&\s-1CTAN\s0 server. Since these features can change over time the configuration is not -hard-coded in \fBctan-o-mat\fR. You can request a template of the -configuration via the command line parameter \f(CW\*(C`\-init\*(C'\fR. +hard-coded in \fBctan-o-mat\fR. You can request an empty template of the +configuration via the command line parameter \f(CW\*(C`\-\-init\*(C'\fR. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\-h" 4 @@ -178,16 +180,6 @@ configuration via the command line parameter \f(CW\*(C`\-init\*(C'\fR. .IX Item "--help" .PD Print this short summary about the usage and exit the program. -.IP "\-\-validate" 4 -.IX Item "--validate" -.PD 0 -.IP "\-n" 4 -.IX Item "-n" -.IP "\-\-noaction" 4 -.IX Item "--noaction" -.PD -Do not perform the final upload. The package is validated and the -resulting messages are printed. .IP "\-i" 4 .IX Item "-i" .PD 0 @@ -195,6 +187,15 @@ resulting messages are printed. .IX Item "--init" .PD Create an empty template for a configuration. +.IP "\-\-config " 4 +.IX Item "--config " +.PD 0 +.IP "\-\-pkg " 4 +.IX Item "--pkg " +.IP "\-\-package " 4 +.IX Item "--package " +.PD +Set the package configuration file. .IP "\-s" 4 .IX Item "-s" .PD 0 @@ -215,11 +216,28 @@ Print some more information during the processing (verbose mode). Print the version number of this program and exit. .IP "\-\-validate" 4 .IX Item "--validate" -Print some additional debugging information. +.PD 0 +.IP "\-n" 4 +.IX Item "-n" +.IP "\-\-noaction" 4 +.IX Item "--noaction" +.PD +Do not perform the final upload. The package is validated and the +resulting messages are printed. .IP "" 4 .IX Item "" This parameter is the name of a package configuration (see section \s-1CONFIGURATION\s0) contained in a file. +If not set otherwise the package configuration defaults to the +name of the current directory with \f(CW\*(C`.pkg\*(C'\fR appended. +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +The following environment variables are recognized by \fBctan-o-mat\fR. +.IP "\s-1CTAN_O_MAT_URL\s0" 4 +.IX Item "CTAN_O_MAT_URL" +The value is the \s-1URL\s0 prefix for the \s-1CTAN\s0 server to be contacted. The default +is \f(CW\*(C`https://ctan.org/submit\*(C'\fR. The complete \s-1URL\s0 is constructed by appending +\&\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 .SH "CONNECTING VIA PROXIES" .IX Header "CONNECTING VIA PROXIES" If you need to connect to the Internet via a proxy then this can be achieved -- cgit v1.2.3