summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/sty2dtx/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/sty2dtx/README')
-rw-r--r--Master/texmf-dist/doc/support/sty2dtx/README67
1 files changed, 48 insertions, 19 deletions
diff --git a/Master/texmf-dist/doc/support/sty2dtx/README b/Master/texmf-dist/doc/support/sty2dtx/README
index 99388299b5f..f9f93a2a457 100644
--- a/Master/texmf-dist/doc/support/sty2dtx/README
+++ b/Master/texmf-dist/doc/support/sty2dtx/README
@@ -1,6 +1,17 @@
sty2dtx -- Converts a LaTeX .sty file to a documented .dtx file
-Version: v2.0 2011/01/31
+Version: v2.1 2011/02/02
+QUICK START:
+To generate a .DTX and .INS file from an existing .STY file run:
+
+ sty2dtx.pl -IB yourfile.sty
+
+The script name might be only 'sty2dtx' without the '.pl' on your installation.
+Also try to run it explicitly with perl: "perl sty2dtx.pl -IB yourfile.sty"
+
+
+
+DESCRIPTION:
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'
@@ -11,6 +22,8 @@ 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.
+
+LICENCE & COPYRIGHT
Copyright (c) 2010-2011 Martin Scharrer <martin@scharrer-online.de>
This program is free software: you can redistribute it and/or modify
@@ -27,24 +40,6 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-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.
-
USAGE:
@@ -102,3 +97,37 @@ Examples:
Produce DTX file for a class:
sty2dtx.pl --type class mycls.sty mycls.dtx
+
+
+SUPPORTED FORMAT
+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.
+
+
+CHANGELOG
+ v1.0 2011/01/29 : First release. Generation of DTX code section only
+ v2.0 2011/01/31 : Generation of full DTX files with many available options
+ v2.1 2011/02/02 : Improved handling of comments included in the STY file
+
+
+FEEDBACK & BUG REPORTS
+Please do not hesitate to contact the author
+Martin Scharrer <martin@scharrer-online.de> for any remarks, questions
+and errors about the script.
+If you use and like it please tell him so!
+