Debian Codegraph @

texmf-dist/doc/man/man1/pamphletangler.1

raw
1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 . if \nF \{\
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{\
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
75 .if n \{\
76 . ds #H 0
77 . ds #V .8m
78 . ds #F .3m
79 . ds #[ \f1
80 . ds #] \fP
81 .\}
82 .if t \{\
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 . ds #V .6m
85 . ds #F 0
86 . ds #[ \&
87 . ds #] \&
88 .\}
89 . \" simple accents for nroff and troff
90 .if n \{\
91 . ds ' \&
92 . ds ` \&
93 . ds ^ \&
94 . ds , \&
95 . ds ~ ~
96 . ds /
97 .\}
98 .if t \{\
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 . ds : e
123 . ds 8 ss
124 . ds o a
125 . ds d- d\h'-1'\(ga
126 . ds D- D\h'-1'\(hy
127 . ds th \o'bp'
128 . ds Th \o'LP'
129 . ds ae ae
130 . ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "PAMPHLETANGLER 1"
136 .TH PAMPHLETANGLER 1 "2019-09-09" "clojure-pamphlet" "Ernesto Lanchares"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 pamphletangler \- Extract code bits from LaTeX pamphlet files.
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 \&\fBpamphletangler\fR [\s-1OPTION...\s0] \fI\s-1FILE\s0\fR \fI\s-1CHUNKNAME\s0\fR
146 .SH "DESCRIPTION"
147 .IX Header "DESCRIPTION"
148 The clojure pamphlet system is a system based on the clojure literate
149 system. In the clojure's pamphlet system you have your main LaTeX file, which
150 can be compiled regularly. This file contains documentation and source code
151 (just like in other forms of literate programming). This code snippets are
152 wrapped in the 'chunk' environment, hence they can be recognized by the tangler
153 in order to extract them. Chunks can be included inside each other by the
154 \&'getchunk' command (which will be typesetted acordingly). Finally, you run your
155 LaTeX file through the tangler and get your desired chunk of code.
156 .SH "OPTIONS"
157 .IX Header "OPTIONS"
158 .IP "\-L, \-\-line=linetext" 29
159 .IX Item "-L, --line=linetext"
160 If set, this text will be inserted after jumps of lines, changing the string
161 inside \*(L"changetext\*(R" for the line number. This is used so that error report
162 refers to pamphlet line number instead of output line number
163 .IP "\-C, \-\-change=changetext" 29
164 .IX Item "-C, --change=changetext"
165 Defaults to \*(L"{}\*(R" this is the text that will be replaced with the line number if
166 the linetext option is specified
167 .IP "\-?, \-\-help" 29
168 .IX Item "-?, --help"
169 Give this help list
170 .IP "\-\-usage" 29
171 .IX Item "--usage"
172 Give a short usage message
173 .IP "\-\-man" 29
174 .IX Item "--man"
175 Print manual page
176 .IP "\-V, \-\-version" 29
177 .IX Item "-V, --version"
178 Print program version
179 .SH "LICENSE"
180 .IX Header "LICENSE"
181 Copyright (C) 2019 Ernesto Lanchares Sanchez.
182 .PP
183 .Vb 5
184 \& The clojure\-pamphlet tagler is free software; you can redistribute
185 \& it and/or modify it under the terms of the GNU Lesser General
186 \& Public License as published by the Free Software Foundation;
187 \& either version 3 of the License, or (at your option) any later
188 \& version.
189 \&
190 \& The clojure\-pamphlet tangler is distributed in the hope that it
191 \& will be useful, but WITHOUT ANY WARRANTY; without even the implied
192 \& warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
193 \& See the GNU Lesser General Public License for more details.
194 \&
195 \& You should have received a copy of the GNU Lesser General Public
196 \& License along with this program; if not, see
197 \& L<http://www.gnu.org/licenses/>.
198 .Ve
199 .SH "AUTHOR"
200 .IX Header "AUTHOR"
201 Ernesto Lanchares <[email protected]>
202 .SH "BUGS"
203 .IX Header "BUGS"
204 Report bugs to [email protected]