#!/usr/bin/env perl use strict; use warnings; ################################################################################ # $Id: sty2dtx.pl 2125 2011-02-02 15:25:40Z martin $ ################################################################################ my $COPYRIGHT = << 'EOT'; Copyright (c) 2010-2011 Martin Scharrer This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . EOT ################################################################################ my $DESCRIPTION = << 'EOT'; Converts a .sty file (LaTeX package) to .dtx format (documented LaTeX source), by surrounding macro definitions with 'macro' and 'macrocode' environments. The macro name is automatically inserted as an argument to the 'macro' environemnt. Code lines outside macro definitions are wrapped only in 'macrocode' environments. Empty lines are removed. The script is not thought to be fool proof and 100% accurate but rather as a good start to convert undocumented style files to .dtx files. Usage: perl sty2dtx.pl infile [infile ...] outfile or perl sty2dtx.pl < file.sty > file.dtx The following macro definitions are detected when they are at the start of a line (can be prefixed by \global, \long, \protected and/or \outer): \def \edef \gdef \xdef \newcommand{\name} \newcommand*{\name} \newcommand\name \newcommand*\name \renewcommand{\name} \renewcommand*{\name} \renewcommand\name \renewcommand*\name \providecommand{\name} \providecommand*{\name} \providecommand\name \providecommand*\name \@namedef{\name} \@namedef\name The following environment definitions are detected when they are at the start of a line: \newenvironment{name} \renewenvironemnt{name} \provideenvironment{name} The macro and environment definition must either end at the same line or with a '}' on its own on a line. EOT ################################################################################ my $VERSION = "v2.1 " . substr( '$Date: 2011-02-02 15:25:40 +0000 (Wed, 02 Feb 2011) $', 7, 10 ); $VERSION =~ tr/-/\//; my $TITLE = << "EOT"; sty2dtx -- Converts a LaTeX .sty file to a documented .dtx file Version: $VERSION EOT sub usage { print << "EOT"; sty2dtx.pl [] [--= ...] [--] [ ...] [] Version: $VERSION EOT print << 'EOT'; Files: * can be '-' for STDIN or STDOUT, which is the default if no files are given * multiple input files are merged to one output file Variables: can be defined using --= or -- and will be used for substitutions in the template file. Common variables: author, email, maintainer, year (for copyright), version, date, description (of package/class), type (either 'package' default or 'class'), filebase (automatically set from output or input file name), Options: -h : Print this help text -H : Print extended help -V : Print version and copyright -v : Be verbose -o : Use given file as output -O : Overwrite already existing output file(s) -B : Use basename of single input file for output file -I : Also create .ins (install) file -c : Only use code section (like v1.0) -i : Create .ins file with given name -t