From 404295945338957d9a80eaa874eb850d1e689be7 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 8 Sep 2011 22:43:49 +0000 Subject: ctanupload (8sep11) git-svn-id: svn://tug.org/texlive/trunk@23874 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/support/ctanupload/README | 11 ++++--- .../doc/support/ctanupload/ctanupload.pdf | Bin 140254 -> 144935 bytes .../doc/support/ctanupload/ctanupload.tex | 32 +++++++++++++++++---- 3 files changed, 34 insertions(+), 9 deletions(-) (limited to 'Master/texmf-dist/doc/support') diff --git a/Master/texmf-dist/doc/support/ctanupload/README b/Master/texmf-dist/doc/support/ctanupload/README index 7a613440dee..8554fc7a0bd 100644 --- a/Master/texmf-dist/doc/support/ctanupload/README +++ b/Master/texmf-dist/doc/support/ctanupload/README @@ -14,16 +14,19 @@ Arguments can also be given using the CTANUPLOAD environment variable which are explicit arguments will overwrite them. Options: - -h Print this help and exit. + -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 CTAN URL to upload to. + -u CTAN URL to upload to (defaults to CTAN_URL environment variable or random if not set) -U CTAN server to upload to, either 'dante' or 'uktug'. -F Read data from file -f Force upload even if input seems incorrect (unknown license etc.). - -p Prompt for missing values. (default if run in terminal) - -P Do not prompt for missing values. (default if not run in terminal) -v Verbose mode. -q Quiet mode. + -l Write log file. + -L Do not write log file. (default) + -o 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 diff --git a/Master/texmf-dist/doc/support/ctanupload/ctanupload.pdf b/Master/texmf-dist/doc/support/ctanupload/ctanupload.pdf index 7e4930d7fdc..2c98b3715e6 100644 Binary files a/Master/texmf-dist/doc/support/ctanupload/ctanupload.pdf and b/Master/texmf-dist/doc/support/ctanupload/ctanupload.pdf differ diff --git a/Master/texmf-dist/doc/support/ctanupload/ctanupload.tex b/Master/texmf-dist/doc/support/ctanupload/ctanupload.tex index 79d266062a8..5b41e9f51c4 100644 --- a/Master/texmf-dist/doc/support/ctanupload/ctanupload.tex +++ b/Master/texmf-dist/doc/support/ctanupload/ctanupload.tex @@ -3,7 +3,7 @@ \title{The \textsf{ctanupload} script} \author{Martin Scharrer} \email{martin@scharrer.me} -\date{Version v1.1 -- 2011/09/06} +\date{Version v1.2 -- 2011/09/08} \providecommand\envvar{\texttt} @@ -57,16 +57,19 @@ followed by multiple options. \toprule \normalfont Option & Description \\ \midrule - -h & Print this help and exit.\\ + -p & Prompt for missing values.\\ + -P & Do not prompt for missing values. (default)\\ -y & Do not ask for confirmation, but submit immediately.\\ -u & CTAN URL to upload to.\\ -U & CTAN server to upload to, either 'dante' or 'uktug'.\\ -F & Read all data from file. (See below)\\ -f & Force upload even if input seems incorrect (unknown license etc.).\\ - -p & Prompt for missing values.\\ - -P & Do not prompt for missing values. (default)\\ + -l & Write log file. \\ + -L & Do not write log file. (default) \\ + -o & Define log file. (still requires -l) \\ -v & Verbose mode. (Passed to the underlying WWW Perl module)\\ -q & Quiet mode. (Passed to the underlying WWW Perl module)\\ + -h & Print help and exit.\\ -V & Print version number.\\ \bottomrule \end{tabular} @@ -86,7 +89,7 @@ The following fields exists in the CTAN upload form. At least the ones marked as directory & Suggested CTAN directory\\ DoNotAnnounce & No need to announce this update\\ announce & Short description for announcement\\ - notes & Optional notes to the CTAN maintainers\\ + notes & Optional notes to the CTAN maintainers (DANTE server only)\\ license & License type (see below) & *\\ freeversion & Which free license (see below)\\ file & File to upload & *\\ @@ -133,6 +136,25 @@ can have one of the following values: \bottomrule \end{tabular} +\subsubsection*{File input and output} + +The upload fields can also be loaded from a text file using the \texttt{-F} option. +Such a file needs to hold one field per line in the form `|name = value|'. +The name should start at the very beginning of a new line. The rest of the line after the equal sign is taken as value. +The \texttt{announce} and \texttt{notes} field can be followed by additional lines of content. +These lines should not start with any content similar to the `|name =|' format, where `|name|' is a single word. +Simply indenting such lines with a space suffices. +Empty lines and line which start with a `|#|', with or without leading spaces, are ignored. + +This format is also used when the upload fields are written to a file. This is done when the edit (`|e|') or save (`|s|') option +is selected. This allows the direct editing of this file or the later reuse of all or selected fields, respectively. + +Using the \texttt{-l} option the upload data and response can be stored in a log file. +This file is generated in the above format with all extra information starting with `|#|', so that it can be loaded again afterwards. +The log file name can be given using the \texttt{-o} option or using the \texttt{CTANUPLOAD\_LOGFILE} environment variable. +Otherwise the log file name defaults to \MacroArgs'ctanupload_''_''.log' + + \section{Examples} \def\example#1{\par\medskip\par\noindent\textbf{#1}\par} -- cgit v1.2.3