1
=== added file '.bzrignore'
2
--- .bzrignore	1970-01-01 00:00:00 +0000
3
+++ .bzrignore	2014-09-01 04:44:23 +0000
4
@@ -0,0 +1,30 @@
5
1
*.aux
6
2
*.d
7
3
*.dvi
8
4
*.fls
9
5
*.glg
10
6
*.glo
11
7
*.gls
12
8
*.idx
13
9
*.ilg
14
10
*.ind
15
11
*.log
16
12
*.make
17
13
*.nav
18
14
*.out
19
15
*.pdf
20
16
*.ps
21
17
*.snm
22
18
*.toc
23
19
*.xdy
24
20
revision.tex
25
21
test-*.tex
26
22
titlepage/cover-proposal 2.svg
27
23
titlepage/preview.png
28
24
titlepage/renders
29
25
titlepage/trash
30
26
ubuntu-manual-*
31
27
ccicons
32
28
coverpage.pdf
33
29
*.tdo
34
30
titlepage/titlepage-*.svg
35
0
31
36
=== renamed file '.bzrignore' => '.bzrignore.moved'
37
=== added file '.gcfunctions'
38
--- .gcfunctions	1970-01-01 00:00:00 +0000
39
+++ .gcfunctions	2014-09-01 04:44:23 +0000
40
@@ -0,0 +1,15 @@
41
1
make_translation:
42
2
  name: Make Translated PDF
43
3
  command: make show-mylang
44
4
  show-in: any
45
5
  offline: True
46
6
make_release:
47
7
  name: Make PDF
48
8
  command: make show
49
9
  show-in: any
50
10
  offline: True
51
11
make_clean:
52
12
  name: Make Clean
53
13
  command: make clean
54
14
  show-in: any
55
15
  offline: True
56
0
16
57
=== added directory 'Help'
58
=== added directory 'Help/godbyk'
59
=== added directory 'Help/godbyk/latex-handout'
60
=== added file 'Help/godbyk/latex-handout/Makefile'
61
--- Help/godbyk/latex-handout/Makefile	1970-01-01 00:00:00 +0000
62
+++ Help/godbyk/latex-handout/Makefile	2014-09-01 04:44:23 +0000
63
@@ -0,0 +1,15 @@
64
1
all: latex-handout.pdf
65
2
66
3
.PHONY: all clean show
67
4
68
5
latex-handout.pdf: latex-handout.tex
69
6
	xelatex latex-handout
70
7
	xelatex latex-handout
71
8
	xelatex latex-handout
72
9
73
10
show: latex-handout.pdf
74
11
	evince $< &
75
12
76
13
clean:
77
14
	-for F in aux log dvi pdf out toc glo idx bbl blg; do rm -fr *.$${F}; done
78
15
79
0
16
80
=== added symlink 'Help/godbyk/latex-handout/graphics'
81
=== target is u'../../../graphics/'
82
=== added file 'Help/godbyk/latex-handout/latex-handout.tex'
83
--- Help/godbyk/latex-handout/latex-handout.tex	1970-01-01 00:00:00 +0000
84
+++ Help/godbyk/latex-handout/latex-handout.tex	2014-09-01 04:44:23 +0000
85
@@ -0,0 +1,433 @@
86
1
\documentclass{ubuntu-manual}
87
2
88
3
\hypersetup{colorlinks}
89
4
90
5
\usepackage{booktabs}
91
6
\usepackage{hyphenat}
92
7
93
8
\title{Ubuntu Manual: \protect\LaTeX{} for Authors and Translators}
94
9
\author{Kevin Godby}
95
10
96
11
97
12
\newcommand{\email}[1]{\href{mailto:#1}{#1}}
98
13
99
14
\newcommand{\parg}[1]{$\langle$\textrm{\textit{#1}}$\rangle$}
100
15
\newcommand{\oarg}[1]{\texttt{[\parg{#1}]}}
101
16
\newcommand{\marg}[1]{\texttt{\{\parg{#1}\}}}
102
17
\newcommand{\cmd}[1]{\texttt{\textbackslash#1}}
103
18
\newcommand{\cs}[1]{\texttt{\textup{\textbackslash#1}}}
104
19
105
20
\newcommand{\highlight}[1]{\textcolor{important}{#1}}
106
21
\newcommand{\tr}[1]{\textcolor{important}{#1}}
107
22
\newcommand{\ntr}[1]{#1}
108
23
\newcommand{\tmarg}[1]{\marg{\tr{#1}}}
109
24
\newcommand{\toarg}[1]{\oarg{\tr{#1}}}
110
25
\newcommand{\tparg}[1]{\parg{\tr{#1}}}
111
26
112
27
113
28
\newenvironment{example}{%
114
29
  \begin{quote}%
115
30
    \setlength{\parindent}{0pt}%
116
31
    \setlength{\parskip}{\baselineskip}%
117
32
    \raggedright\sloppy\language\langwohyphens
118
33
}{%
119
34
  \end{quote}%
120
35
}
121
36
122
37
\begin{document}
123
38
124
39
\maketitle
125
40
126
41
\tableofcontents
127
42
128
43
\chapter{Introduction}
129
44
130
45
The \href{http://wiki.ubuntu.com/ubuntu-manual/}{Ubuntu Manual} project has set out to produce a beginner's guide for Ubuntu, covering everything from installation to commonly used applications.  The manual will be provided in \smallcaps{PDF} format in a variety of languages and will be freely available.  To generate the \smallcaps{PDF}s, we use \LaTeX.  
131
46
132
47
\LaTeX{} is a typesetting system that has been around for over twenty years.  Since \LaTeX{} is a large (and sometimes complex) system this guide will only cover what you need to know to write, edit, and translate the contents of the Ubuntu Manual.
133
48
134
49
If you have questions or run into any problems that this guide doesn't cover, feel free to email the Ubuntu Manual mailing list at \email{ubuntu-manual@lists.launchpad.net}.
135
50
136
51
\chapter{The Basics}
137
52
138
53
\section{Getting Started}\label{sec:getting-started}
139
54
140
55
% Add pointers to getting the source code and using Rosetta.
141
56
142
57
As an author or editor, you will be modifying the Ubuntu Manual source files directly.  The source files for \LaTeX{} have a \texttt{.tex} extension.  You can edit the source files using your favorite text editor such as emacs, vim, or GEdit.  \LaTeX{} code is similar to \smallcaps{HTML} in that most of the ``code'' is simply the text of the manual with a few formatting commands sprinkled in.
143
58
144
59
Translators should also familiarize themselves with the basics of \LaTeX{} formatting and read the special translator notes starting on page~\ref{sec:notes-for-translators}.
145
60
146
61
\section{Organization of Files}
147
62
148
63
Each of the chapters of the manual has its own subdirectory:
149
64
150
65
\begin{center}
151
66
  \begin{tabular}{ll}
152
67
    \toprule
153
68
    Chapter & Directory name \\
154
69
    \midrule
155
70
    Prologue & \texttt{prologue} \\
156
71
    1. Installation & \texttt{installation} \\
157
72
    2. Around Your Desktop & \texttt{around-desktop} \\
158
73
    3. Default Applications & \texttt{default-apps} \\
159
74
    4. Preferences and Hardware & \texttt{prefs-hardware} \\
160
75
    5. Software and Packaging & \texttt{software-packaging} \\
161
76
    6. System Maintenance & \texttt{maintenance} \\
162
77
    7. The Command Line & \texttt{command-line} \\
163
78
    8. Security & \texttt{security} \\
164
79
    9. Troubleshooting & \texttt{troubleshooting} \\
165
80
    10. Learning More About Linux & \texttt{learning-more} \\
166
81
    \bottomrule
167
82
  \end{tabular}
168
83
\end{center}
169
84
170
85
Once you've selected a chapter that you'd like to help write or edit, you will find a \texttt{.tex} file in that chapter's directory.  Some chapters will have all of their text in that one file, while other chapters have split each section into its own file.  If you see a bunch of \verb|\input| commands in the file, then you will have to look in the appropriate \texttt{.tex} file for the text of that section.
171
86
172
87
173
88
174
89
175
90
\chapter{Style Guide}\label{ch:style-guide}
176
91
177
92
%\section{Writing Style}\label{sec:writing-style}% Not LaTeX-related
178
93
179
94
180
95
\section{Formatting Text}\label{sec:formatting-text}
181
96
\subsection{Punctuation}\label{sec:punctuation}
182
97
183
98
\paragraph{Quotation marks} Quotation marks in \LaTeX{} are entered as \verb|``| and \verb|''|, \emph{not} as \verb|"|.
184
99
Single quotation marks are entered as \verb|`| and \verb|'|.  Quotation marks for other languages are entered as their Unicode characters.% TODO This may change if we use csquotes.
185
100
186
101
\paragraph{Indicating sudden breaks} To indicate a sudden break in thought---like this---use an em dash.  To enter an em dash in the manual, use the \cmd{dash} command.  This command will print an em dash without spaces---like this---for US English, but can be set to print an en dash with spaces\,--\,like this\,--\,for other languages such as UK English.
187
102
188
103
\paragraph{Indicating a range}  If you wish to indicate a range (such as: pages 37--40 or 2005--2007), use an en dash.  An en dash is entered in \LaTeX{} as two hyphens: \verb|--|.  Do not put spaces before of after the en dash when used to indicate a range.
189
104
190
105
\paragraph{Special characters}  There are a few characters that \LaTeX{} considers special (used for its own syntax).  To typeset these characters, precede the character with a backslash (\texttt{\textbackslash}).  The special characters are:
191
106
192
107
\begin{example}
193
108
  \centering \$ \qquad \% \qquad \_ \qquad \{ \qquad \} \qquad \& \qquad \#
194
109
\end{example}
195
110
The above line was typed like this:
196
111
\begin{example}
197
112
  \centering \ttfamily \cmd{\$} \qquad \cmd{\%} \qquad \cmd{\_} \qquad \cmd{\{} \qquad \cmd{\}} \qquad \cmd{\&} \qquad \cmd{\#}
198
113
\end{example}
199
114
Finally, to type a backslash character, use the \cmd{textbackslash} command.
200
115
201
116
\section{GUI Elements}
202
117
203
118
\paragraph{Menu items}  To give a sequence of menu items that should be selected, use the \verb|\menu| and \verb|\then| commands.  For example:
204
119
\begin{example}
205
120
  To open the Calculator application, click \menu{Applications\then Accessories\then Calculator}.
206
121
\end{example}
207
122
is typeset by:
208
123
\begin{example}
209
124
  \ttfamily To open the Calculator application, click \string\menu\string{Applications\string\then\space Accessories\string\then\space Calculator\string}.
210
125
\end{example}
211
126
212
127
Use the \cmd{menu} command for single menu items as well:
213
128
\begin{example}
214
129
  Pull down the \menu{File} menu and then click \menu{Quit}.
215
130
\end{example}
216
131
217
132
\paragraph{Other \smallcaps{GUI} elements}  There are commands for other \smallcaps{GUI} elements as well:
218
133
219
134
\medskip
220
135
\begin{center}
221
136
  \begin{tabular}{lll}
222
137
    \toprule
223
138
  	\smallcaps{GUI} element & Command & Appearance \\
224
139
  	\midrule
225
140
  	Button & \verb|button| & \button{Cancel} \\
226
141
  	Tab & \verb|\tab| & \tab{Advanced} \\
227
142
  	Drop-down list & \verb|\dropdown| & \dropdown{Country} \\
228
143
  	Checkbox & \verb|\checkbox| & \checkbox{Remember my password} \\
229
144
  	Window title & \verb|\window| & \checkbox{Preferences} \\
230
145
  	Keyboard key(s) & \verb|\keystroke| & \keystroke{Ctrl+Q} \\
231
146
  	Radio button & \verb|\radiobutton| & \radiobutton{Single click to open items} \\
232
147
  	Text box & \verb|\textfield| & \textfield{Full name} \\
233
148
  	\bottomrule
234
149
  \end{tabular}
235
150
\end{center}
236
151
237
152
\paragraph{Application names}  The names of applications should be typeset with the \verb|\application| command.  This will add the application to the index automatically.  For command-line--based applications, use the \verb|\commandlineapp| command instead.
238
153
239
154
\paragraph{User input} When quoting what a user should type, use the \verb|\userinput| command.  If you're just having the user press a key on the keyboard, use the \verb|\keystroke| command instead.  For example:
240
155
\begin{quotation}
241
156
  \ttfamily Type \string\userinput\string{Hello, world!\string} and press \string\keystroke\string{Enter\string}.
242
157
\end{quotation}
243
158
is typeset as:
244
159
\begin{quotation}
245
160
  Type \userinput{Hello, world!} and press \keystroke{Enter}.
246
161
\end{quotation}
247
162
248
163
\paragraph{Cross-referencing}  In a manual of this size, it's often helpful to point the reader to another chapter or section for more information on a related topic.  There are few commands that can help you do that.  To cross-reference another chapter, use the \verb|\chaplink| command.  Similarly, to cross-reference a section of a chapter, use the \verb|\seclink| command.  The \verb|\chaplink| command will insert the text ``Chapter \parg{X}: \parg{Chapter Title}'' and link it to the beginning of that chapter.  The \verb|\seclink| command will insert the name of the section and link it to that section.% TODO provide examples
249
164
250
165
% TODO provide actual command references
251
166
252
167
253
168
\section{Graphics}\label{sec:graphics}
254
169
255
170
If a screenshot should be added at some point, make a note of it using the \verb|\screenshotTODO| command.  Provide a description of what the screenshot should depict.  This will add a warning notice in the \smallcaps{PDF} and will add that screenshot to the to do list.
256
171
257
172
\screenshotTODO{Firefox web browser window}
258
173
259
174
% TODO Write about how to insert a screenshot into the document.
260
175
261
176
\section{Other document elements}
262
177
263
178
\paragraph{Paragraphs} To start a new paragraph in \LaTeX{}, just add a blank line.  You don't need to indent the paragraphs as \LaTeX{} will take care of this for you.
264
179
265
180
\paragraph{Margin notes} The manual uses margin notes to provide definitions, tips, and pointers to more information. To add a margin note, use the \cmd{marginnote} command:
266
181
\begin{example}
267
182
  \ttfamily \cmd{marginnote}\marg{Margin note text}
268
183
\end{example}
269
184
270
185
\paragraph{Comments}  If you want to add a note to yourself (or others) in the \texttt{.tex} file, just type a percent sign (\%) followed by your note.  \LaTeX{}
271
186
ll ignore everything on the line after the percent sign.
272
187
\begin{example}
273
188
  \ttfamily This text will appear in the PDF. \% But this text won't!
274
189
\end{example}
275
190
276
191
Remember, if you want a percent sign to actually appear in the \smallcaps{PDF}, you'll need to precede it with a backslash:
277
192
\begin{example}
278
193
  \ttfamily Linux users are 50\cmd{\%} smarter than non-Linux users.
279
194
\end{example}
280
195
281
196
\paragraph{Terminal commands} There are also special commands for typesetting text that appears or is entered into a terminal. An example will illustrate the commands:
282
197
\begin{example}
283
198
  \parskip0pt\obeylines
284
199
  \ttfamily The \cmd{commandlineapp}\{fortune\} program works like this:
285
200
  \cmd{begin}\{terminal\}
286
201
  \cmd{prompt} \cmd{userinput}\{fortune\}
287
202
  What we have to learn to do we learn by doing.
288
203
  \ \ \ -- Aristotle, Ethica Nicomachea II (c. 325 BC)
289
204
  \cmd{end}\{terminal\}
290
205
\end{example}
291
206
The above generates the following output:
292
207
\begin{example}
293
208
  The \commandlineapp{fortune} program works like this:
294
209
  \begin{terminal}
295
210
    \prompt \userinput{fortune}
296
211
    What we have to learn to do we learn by doing.
297
212
    \ \ \ -- Aristotle, Ethica Nicomachea II (c. 325 BC)
298
213
  \end{terminal}
299
214
\end{example}
300
215
301
216
The \cmd{prompt} command will print a \smallcaps{BASH}-style user prompt (\prompt).  The \cmd{rootprompt} command will print a \smallcaps{BASH}-style root prompt (\rootprompt).  The \cmd{userinput} command should contain any text that the user types in. 
302
217
303
218
While the \texttt{terminal} environment is handy for multiple lines of terminal input/output, if you want to put terminal text inline with your paragraph text, you can use the \cmd{userinput} and \cmd{code} commands.
304
219
305
220
\paragraph{Warnings and notices for advanced instructions}  While the instructions in this manual should be as safe as possible, we sometimes mention commands or programs that can potentially do damage if not used correctly.  To draw attention to these rare circumstances, you can put a note in the \cmd{warning} command.  This will set the text off so it's more eye-catching.
306
221
307
222
Similarly, there is a \cmd{advanced} command for notes to advanced users.
308
223
309
224
\paragraph{Lists}  There are two types of lists that we use in the manual: numbered lists and bulleted lists.  Both lists work the same way, they just have different names.
310
225
311
226
  \begin{minipage}{0.4\textwidth}
312
227
    \parskip0.5\baselineskip
313
228
    \parindent0pt
314
229
    \begin{flushleft}
315
230
      \ttfamily
316
231
      \string\begin\{itemize\}\\
317
232
      \ \ \string\item\ First list item\\
318
233
      \ \ \string\item\ Second list item\\
319
234
      \ \ \string\item\ Third list item\\
320
235
      \string\end\{itemize\}
321
236
    \end{flushleft}
322
237
    produces:\\
323
238
    \begin{flushleft}
324
239
      \rmfamily
325
240
      \begin{itemize}
326
241
        \item First list item
327
242
        \item Second list item
328
243
        \item Third list item
329
244
      \end{itemize}
330
245
    \end{flushleft}
331
246
  \end{minipage}
332
247
  \hfill
333
248
  \begin{minipage}{0.4\textwidth}
334
249
    \parskip0.5\baselineskip
335
250
    \parindent0pt
336
251
    \begin{flushleft}
337
252
      \ttfamily
338
253
      \string\begin\{enumerate\}\\
339
254
      \ \ \string\item\ First list item\\
340
255
      \ \ \string\item\ Second list item\\
341
256
      \ \ \string\item\ Third list item\\
342
257
      \string\end\{enumerate\}
343
258
    \end{flushleft}
344
259
    produces:
345
260
    \begin{flushleft}
346
261
      \rmfamily
347
262
      \begin{enumerate}
348
263
        \item First list item
349
264
        \item Second list item
350
265
        \item Third list item
351
266
      \end{enumerate}
352
267
    \end{flushleft}
353
268
  \end{minipage}
354
269
355
270
356
271
\chapter{Notes for Translators}\label{sec:notes-for-translators}
357
272
358
273
\LaTeX{} commands are preceded by a backslash character (\texttt{\textbackslash}). While the command names should not be translated, their arguments sometimes should be.
359
274
360
275
In the following list of commands, the \tr{red} text should be translated and the black text should not be translated.
361
276
362
277
\section{Document headings}
363
278
\begin{itemize}\ttfamily
364
279
  \item \cs{title}\tmarg{book title}
365
280
  \item \cs{author}\tmarg{book authors}
366
281
  \item \cs{part}\tmarg{part heading}
367
282
  \item \cs{chapter}\tmarg{chapter heading}
368
283
  \item \cs{section}\tmarg{section heading}
369
284
  \item \cs{subsection}\tmarg{subsection heading}
370
285
  \item \cs{subsubsection}\tmarg{subsubsection heading}
371
286
  \item \cs{paragraph}\tmarg{paragraph heading}
372
287
  \item \cs{subparagraph}\tmarg{subparagraph heading}
373
288
\end{itemize}
374
289
375
290
\section{Formatting commands}
376
291
\begin{itemize}\ttfamily
377
292
  \item \cs{marginnote}\tmarg{margin note text}
378
293
  \item \cs{textbf}\tmarg{bold text}
379
294
  \item \cs{textit}\tmarg{italic text}
380
295
  \item \cs{emph}\tmarg{italic text}
381
296
  \item \cs{smallcaps}\tmarg{acronym}
382
297
  \item \cs{application}\tmarg{application name}
383
298
  \item \cs{commandlineapp}\tmarg{command-line application name}
384
299
  \item \cs{menu}\marg{\tparg{menu name} \cs{then} \tparg{submenu name} \cs{then} \tparg{menu item}}
385
300
  \item \cs{button}\tmarg{button name}
386
301
  \item \cs{checkbox}\tmarg{checkbox name}
387
302
  \item \cs{tab}\tmarg{tab name}
388
303
  \item \cs{dropdown}\tmarg{drop-down list name}
389
304
  \item \cs{window}\tmarg{window name}
390
305
  \item \cs{textfield}\tmarg{text box name}
391
306
  \item \cs{keystroke}\tmarg{Keyboard key names separated by \texttt{+}}
392
307
  \item \cs{userinput}\tmarg{stuff the user types}
393
308
  \item \cs{code}\tmarg{terminal output}
394
309
  \item \cs{begin}\marg{terminal} \tparg{output from the terminal} \cs{end}\marg{terminal}
395
310
  \item \cs{warning}\marg{warning text}
396
311
  \item \cs{advanced}\marg{advanced usage text}
397
312
  \item \cs{screenshot}\marg{filename}\marg{label}\tmarg{caption}
398
313
\end{itemize}
399
314
400
315
\noindent The following formatting commands should \emph{not} be translated:
401
316
\begin{itemize}\ttfamily
402
317
  \item \cs{dash}
403
318
  \item \cs{url}\marg{URL}
404
319
  \item \cs{prompt}
405
320
  \item \cs{rootprompt}
406
321
\end{itemize}
407
322
408
323
\section{Lists}
409
324
The only part of lists that need to be translated is the text of the list items themselves.
410
325
411
326
\begingroup\ttfamily\parindent=0pt\parskip=0pt\noindent
412
327
\cs{begin}\marg{itemize}\quad\textit{or}\quad\cs{begin}\marg{enumerate}\par
413
328
\space\space\cs{item} \tparg{list item text}\par
414
329
\space\space\cs{item} \tparg{another list item}\par
415
330
\cs{end}\marg{itemize}\quad\textit{or}\quad\cs{begin}\marg{enumerate}\par
416
331
\endgroup
417
332
418
333
\section{Author and editor notes}
419
334
Do not translate any of the following commands:
420
335
\begin{itemize}\ttfamily
421
336
  \item \cs{todo}\marg{notes to appear in PDF margin}
422
337
  \item \cs{screenshotTODO}\marg{description of screenshot}
423
338
  \item \cs{begin}\marg{comment} \parg{notes to authors/editors} \cs{end}\marg{command}
424
339
\end{itemize}
425
340
426
341
427
342
\section{Glossary-related commands}
428
343
429
344
\begin{itemize}\ttfamily
430
345
  \item \cs{newglossaryentry}\marg{\ntr{keyword}}\{name=\marg{\tr{term}},description=\marg{\tr{definition}}\}
431
346
  \item \cs{gls}\marg{\ntr{keyword}}
432
347
  \item \cs{glspl}\marg{\ntr{keyword}}
433
348
  \item \cs{Gls}\marg{\ntr{keyword}}
434
349
  \item \cs{Glspl}\marg{\ntr{keyword}}
435
350
\end{itemize}
436
351
437
352
\section{Cross-referencing commands}
438
353
Do not translate any of these commands:
439
354
\begin{itemize}\ttfamily
440
355
  \item \cs{label}\marg{label}
441
356
  \item \cs{ref}\marg{label}
442
357
  \item \cs{pageref}\marg{label}
443
358
  \item \cs{nameref}\marg{label}
444
359
  \item \cs{chaplink}\marg{label}
445
360
  \item \cs{seclink}\marg{label}
446
361
\end{itemize}
447
362
448
363
\section{Other document commands}
449
364
Do not translate any of the following:
450
365
\begin{itemize}\ttfamily
451
366
  \item \cs{frontcover}
452
367
  \item \cs{mainmatter}
453
368
  \item \cs{appendix}
454
369
  \item \cs{backmatter}
455
370
  \item \cs{providecommand}\marg{command name}\marg{command definition}
456
371
  \item \cs{documentclass}\oarg{options}\marg{document type}
457
372
  \item \cs{include}\marg{file}
458
373
  \item \cs{begin}\marg{environment}
459
374
  \item \cs{end}\marg{environment}
460
375
  \item \cs{printglossaries}
461
376
  \item \cs{printindex}
462
377
  \item \cs{LoadLicenseFile}
463
378
\end{itemize}
464
379
465
380
466
381
\chapter{Notes for Editors}
467
382
468
383
\section{Obsolete commands}
469
384
470
385
There are a few commands that were used in the beginning of the project that have since been replaced.  If you encounter any of these obsolete commands, please replace them with the updated command.
471
386
472
387
\begin{description}
473
388
  \item[\cs{menuitem}]  This command should be replaced by the \cs{menu} command.
474
389
  \item[\cs{nav}]  This command should be replaced by the \cs{menu} command.
475
390
  \item[\texttt{-{}-{}-}]  This em dash command should be replaced by the \cs{dash} command.
476
391
\end{description}
477
392
478
393
479
394
\chapter{Installing \protect\TeX{} Live 2009}
480
395
481
396
We're using a number of features that require the latest version of \TeX{} Live (2009).  Unfortunately, the version of \TeX{} Live that comes with Ubuntu 9.10 is \TeX{} Live 2007.  To install \TeX{} Live 2009, follow these steps:
482
397
483
398
\begin{enumerate}
484
399
  \item Uninstall all the Ubuntu TeX Live packages:  \texttt{sudo apt-get remove texlive-*}
485
400
  \item Download the TeX Live 2009 install script:  \url{http://mirror.ctan.org/systems/texlive/tlnet/install-tl-unx.tar.gz}
486
401
  \item Unpack the tarball: \texttt{tar -zxvf install-tl-unx.tar.gz}
487
402
  \item Change to the newly-unpacked directory: \texttt{cd install-tl-*}
488
403
  \item Run the script: \texttt{sudo ./install-tl}
489
404
  \item Select where you'd like to install everything, and any other options you prefer.  I highly recommend enabling the ``create symlinks to standard directories'' option.
490
405
  \item To compile a translation, run: \texttt{make ubuntu-manual-\parg{lang}.pdf}   where \parg{lang} is the language code (see the \texttt{po/} directory for a list of supported languages).
491
406
\end{enumerate}
492
407
493
408
Note that not all languages are supported yet (especially those requiring non-Latin scripts).
494
409
495
410
If you have any questions or run into any problems, feel free to contact me.  I'm usually in \smallcaps{IRC} as ``godbyk'' and can, of course, be contacted via email.
496
411
497
412
498
413
\chapter{Word List}\label{ch:word-list}
499
414
500
415
This chapter contains a list of words with their proper spelling and capitlization.
501
416
502
417
\begin{multicols}{3}
503
418
\obeylines%
504
419
Bluetooth
505
420
dial-up
506
421
Ethernet
507
422
gedit
508
423
GNOME
509
424
GNU/Linux
510
425
KDE
511
426
Red Hat
512
427
session menu
513
428
shut down
514
429
Wi-Fi
515
430
\end{multicols}
516
431
517
432
518
433
\end{document}
519
0
434
520
=== added symlink 'Help/godbyk/latex-handout/tufte-book.cls'
521
=== target is u'../../../tufte-book.cls'
522
=== added symlink 'Help/godbyk/latex-handout/tufte-common.def'
523
=== target is u'../../../tufte-common.def'
524
=== added symlink 'Help/godbyk/latex-handout/ubuntu-manual.cls'
525
=== target is u'../../../ubuntu-manual.cls'
526
=== added directory 'Help/godbyk/latex-slides'
527
=== added file 'Help/godbyk/latex-slides/Makefile'
528
--- Help/godbyk/latex-slides/Makefile	1970-01-01 00:00:00 +0000
529
+++ Help/godbyk/latex-slides/Makefile	2014-09-01 04:44:23 +0000
530
@@ -0,0 +1,15 @@
531
1
all: latex-slides.pdf
532
2
533
3
.PHONY: all clean show
534
4
535
5
latex-slides.pdf: latex-slides.tex
536
6
	xelatex latex-slides
537
7
	xelatex latex-slides
538
8
	xelatex latex-slides
539
9
540
10
show: latex-slides.pdf
541
11
	evince $< &
542
12
543
13
clean:
544
14
	-for F in aux log dvi pdf out toc glo idx bbl blg nav snm; do rm -fr *.$${F}; done
545
15
546
0
16
547
=== added file 'Help/godbyk/latex-slides/latex-slides.tex'
548
--- Help/godbyk/latex-slides/latex-slides.tex	1970-01-01 00:00:00 +0000
549
+++ Help/godbyk/latex-slides/latex-slides.tex	2014-09-01 04:44:23 +0000
550
@@ -0,0 +1,388 @@
551
1
\documentclass[t,unicode,color={usenames,dvipsnames},xcolor={usenames,dvipsnames}]{beamer}
552
2
553
3
\usepackage{xltxtra}
554
4
\usepackage{polyglossia}
555
5
\setromanfont[Mapping=tex-text,Numbers=OldStyle]{Linux Libertine O}
556
6
\setsansfont[Mapping=tex-text,Numbers=OldStyle]{Linux Biolinum O}
557
7
\setmonofont[Mapping=text-text,Scale=MatchLowercase]{DejaVu Sans Mono}
558
8
559
9
560
10
\usepackage{graphics}
561
11
%\usepackage{graphicx}
562
12
563
13
\usepackage{xcolor}
564
14
565
15
\hypersetup{
566
16
    colorlinks,
567
17
    pdftitle={LaTeX for Ubuntu Manual Authors and Translators},
568
18
    pdfauthor={Kevin Godby},
569
19
    pdfcreator={XeLaTeX},
570
20
    pdfkeywords={latex, ubuntu, ubuntu manual, authors, editors, translators, tex, xelatex}
571
21
}
572
22
573
23
%\usepackage{handoutWithNotes}
574
24
%\pgfpagesuselayout{4 on 1 with notes}[letterpaper,border shrink=5mm]
575
25
576
26
\mode<presentation>
577
27
{
578
28
  %\usetheme{Dresden}
579
29
  %\usetheme[
580
30
  %  titlebackgroundimagefile=./images/title-background,
581
31
  %  normalbackgroundimagefile=./images/main-background,
582
32
  %  opacity=0
583
33
  %]{HCI}
584
34
  %\setbeamercovered{transparent}
585
35
}
586
36
587
37
\setbeamertemplate{bibliography item}[article]
588
38
589
39
\usepackage{pifont}   % circles and boxes (for survey dingbats)
590
40
\usepackage{bbding}   % circles and boxes (for survey dingbats)
591
41
592
42
\usepackage[overlay]{textpos} % for absolute positioning
593
43
\setlength{\TPVertModule}{\the\paperheight}
594
44
\setlength{\TPHorizModule}{\the\paperwidth}
595
45
596
46
\usepackage{ummacros}
597
47
598
48
\title{\LaTeX{} for Ubuntu Manual Authors and Translators}
599
49
\author{Kevin Godby}
600
50
%\institute{HCI 522: Scientific Methods of Human--Computer Interaction\\Human--Computer Interaction Program\\Iowa State University}
601
51
\date{22--23 February 2010}
602
52
603
53
\definecolor{important}{HTML}{980101}% same as accent deep red
604
54
\newcommand{\highlight}[1]{\textcolor{important}{#1}}
605
55
606
56
\usepackage{textcase}
607
57
\newcommand{\smallcaps}[1]{\textsc{\MakeTextLowercase{#1}}}
608
58
609
59
\renewenvironment{center}{\par\vskip-0.5\baselineskip\centering}{\par\vskip-0.5\baselineskip}
610
60
\renewenvironment{flushleft}{\par\vskip-0.5\baselineskip\raggedright}{\par\vskip-0.5\baselineskip}
611
61
\renewenvironment{flushright}{\par\vskip-0.5\baselineskip\raggedleft}{\par\vskip-0.5\baselineskip}
612
62
613
63
\begin{document}
614
64
615
65
\setlength{\parindent}{0pt}
616
66
\setlength{\parskip}{\baselineskip}
617
67
618
68
\begin{frame}
619
69
  \titlepage
620
70
\end{frame}
621
71
622
72
\begin{frame}
623
73
  \frametitle{Contents}
624
74
  \tableofcontents
625
75
\end{frame}
626
76
627
77
\section{Introduction}
628
78
629
79
\begin{frame}
630
80
  \frametitle{What is the Ubuntu Manual project about?}
631
81
  \textit{Getting Started with Ubuntu 10.04} aims to be a complete
632
82
  beginner's manual for Ubuntu, featuring comprehensive guides, how-tos and
633
83
  information on anything one needs to know after first installing Ubuntu.
634
84
635
85
  Designed to be as user-friendly and easy-to-follow as possible, it will
636
86
  provide the first point of reference to any Ubuntu newcomer with lots of
637
87
  information in one easy-to-access \smallcaps{PDF}. Plus, every six months there will
638
88
  be a new revision released to coincide with each new release of Ubuntu.
639
89
\end{frame}
640
90
641
91
\begin{frame}
642
92
  \frametitle{What is \LaTeX?}
643
93
  \LaTeX\ is the typesetting system we're using to create the manual's
644
94
  \smallcaps{PDF}.  It's similar to \smallcaps{HTML} in that the text is marked
645
95
  up with special codes to denote the style of the text, but unlike
646
96
  \smallcaps{HTML} it's also a complete programming language.
647
97
648
98
  As authors, editors, and translators, you won't have to worry about the
649
99
  programming side, just the markup side.
650
100
\end{frame}
651
101
652
102
\section{\protect\LaTeX{} for Authors and Editors}
653
103
654
104
\begin{frame}
655
105
  \frametitle{What does \LaTeX{} code look like?}
656
106
  All of the \LaTeX{} code is stored in \texttt{.tex} files.  These files are
657
107
  regular text files that may be edited with your favorite text editor (e.g.,
658
108
  vim, emacs, gedit).
659
109
660
110
  The markup commands in \LaTeX{} begin with a backslash (\textbackslash).  For example,
661
111
  \begin{center}
662
112
    \ttfamily My name is \highlight{\string\textbf\string{Kevin\string}}.
663
113
  \end{center}
664
114
  will be typeset as: 
665
115
  \begin{center}
666
116
    \rmfamily My name is \highlight{\textbf{Kevin}}.
667
117
  \end{center}
668
118
\end{frame}
669
119
670
120
\begin{frame}
671
121
  \frametitle{What does \LaTeX{} code look like?}
672
122
  \vskip\baselineskip%
673
123
  \begin{center}
674
124
    \ttfamily My name is \highlight{\string\textbf\string{}Kevin\highlight{\string}}.
675
125
  \end{center}
676
126
  The \texttt{\string\textbf} command tells \LaTeX{} to print the text in
677
127
  \textbf{boldface} type.  The braces (\texttt{\string{\string}}) tell \LaTeX{}
678
128
  when to start and stop using bold text.
679
129
680
130
  We avoid using these low-level commands, however, preferring instead to use
681
131
  \emph{semantic markup.}  Semantic markup means that, instead of telling
682
132
  \LaTeX{} how something should look, we tell it what something \emph{means}.
683
133
\end{frame}
684
134
685
135
\begin{frame}
686
136
  \frametitle{Semantic Markup}
687
137
  For example, instead of typing:
688
138
  \begin{center}
689
139
    \ttfamily Pull down the \highlight{\string\textbf\string{Help\string}} menu and click \highlight{\string\textbf\string{About\string}}.
690
140
  \end{center}
691
141
  we would say:
692
142
  \begin{center}
693
143
    \ttfamily Pull down the \highlight{\string\menu\string{Help\string}} menu and click \highlight{\string\menu\string{About\string}}.
694
144
  \end{center}
695
145
  This ensures that all the menu items are formatted consistently throughout
696
146
  the manual and also allows us to modify the formatting of the menu items in
697
147
  one place, instead of editing each file.
698
148
699
149
  We'll see a list of these semantic markup commands soon.
700
150
\end{frame}
701
151
702
152
\begin{frame}
703
153
  \frametitle{Special Characters in \LaTeX{}}
704
154
  Most text can be typed just as you'd expect, and everything will work great.  There are, however, a few characters that need special handling.
705
155
706
156
  \LaTeX{} knows the difference between opening and closing quotation marks.  So instead of using the normal quotation marks (\texttt{\string"}), you will need to use two acute accents (``backticks'') for opening quotation marks, and two apostrophes for closing quotation marks:
707
157
  \begin{center}
708
158
    \ttfamily Kevin said, \highlight{\string`\string`}Quotation marks are special.\highlight{\string'\string'}
709
159
  \end{center}
710
160
  To interrupt a sentence, use the \highlight{\ttfamily\string\dash} command.  This allows us to automatically use the appropriate dash based on the language.  (US English uses an em dash without space---like this---while UK English uses an en dash with space\,--\,like this.)
711
161
\end{frame}
712
162
713
163
\begin{frame}
714
164
  \frametitle{More Special Characters in \LaTeX{}}
715
165
  There are a few more characters that \LaTeX{} considers special because it uses them in its programming language.  They are:
716
166
  \begin{center}
717
167
    \ttfamily \$\qquad\%\qquad\_\qquad\{\qquad\}\qquad\&\qquad\#
718
168
  \end{center}
719
169
  If you want one of these characters to appear in the typeset document, put a backslash (\textbackslash) in front of that character.  The above line was typed like this:
720
170
  \begin{center}
721
171
    \ttfamily \textbackslash\$\qquad\textbackslash\%\qquad\textbackslash\_\qquad\textbackslash\{\qquad\textbackslash\}\qquad\textbackslash\&\qquad\textbackslash\#
722
172
  \end{center}
723
173
  Finally, to type a backslash character, use the \texttt{\string\textbackslash} command.
724
174
\end{frame}
725
175
726
176
\begin{frame}
727
177
  \frametitle{Document Structure}
728
178
  \textit{Getting Started} has two parts, over ten chapters, and a slew of sections and subsections.  Each of these heading levels has its own \LaTeX{} command that formats the heading and automatically adds it to the table of contents.
729
179
730
180
  \begin{tabular}{ll}
731
181
    \ttfamily\string\part    & \ttfamily\string\chapter \\
732
182
    \ttfamily\string\section & \ttfamily\string\subsection \\
733
183
    \ttfamily\string\subsubsection
734
184
  \end{tabular}
735
185
736
186
  If you want to add a new section on how to install Frozen Bubble, for example, you would write:
737
187
  \begin{center}
738
188
    \ttfamily \string\section\string{Frozen Bubble\string}
739
189
  \end{center}
740
190
  and \LaTeX{} would print the section heading and add it to the table of contents at the front of the manual.
741
191
\end{frame}
742
192
743
193
\begin{frame}
744
194
  \frametitle{Paragraphs and margin notes}
745
195
  To start a new paragraph in \LaTeX{}, just add a blank line.  You don't need to indent the paragraphs as \LaTeX{} will take care of this for you.
746
196
747
197
  The manual uses margin notes to provide definitions, tips, and pointers to more information.  To add a margin note, use the \texttt{\string\marginnote} command:
748
198
  \begin{flushleft}
749
199
    \ttfamily \highlight{\string\marginnote}\string{This text will appear in the\\
750
200
    \hspace{10em} margin of the manual.\string}
751
201
  \end{flushleft}
752
202
\end{frame}
753
203
754
204
\begin{frame}
755
205
  \frametitle{Comments}
756
206
  If you want to add a note to yourself (or others) in the \texttt{.tex} file,
757
207
  just type a percent sign (\%) followed by your note.  \LaTeX{} will ignore
758
208
  everything on the line after the percent sign.
759
209
  \begin{flushleft}
760
210
    \ttfamily This text will appear in the PDF.
761
211
    \highlight{\% But this text won't!}
762
212
  \end{flushleft}
763
213
764
214
  Remember, if you want a percent sign to actually appear in the \smallcaps{PDF}, you'll need to precede it with a backslash:
765
215
  \begin{flushleft}
766
216
    \ttfamily Linux users are 50\highlight{\textbackslash\%} smarter than non-Linux users.
767
217
  \end{flushleft}
768
218
\end{frame}
769
219
770
220
\begin{frame}
771
221
  \frametitle{GUI Elements}
772
222
  The instructions we write often contain the names of \smallcaps{GUI} elements
773
223
  such as menu items, buttons, check boxes, drop-down lists, etc.  Each of
774
224
  these elements has its own special formatting.  To simplify the formatting of
775
225
  these elements, we've created some new markup commands for them.
776
226
777
227
  If you want to direct the user to choose a menu item, you would write:
778
228
  \begin{flushleft}
779
229
    \ttfamily
780
230
    Click \highlight{\string\menu\string{Applications\string\then\space Accessories\string\then\space Calculator\string}} to start the \highlight{\string\application\string{Calculator\string}} application.
781
231
  \end{flushleft}
782
232
  which produces:
783
233
  \begin{flushleft}
784
234
    \rmfamily
785
235
    Click \highlight{\menu{Applications\then Accessories\then Calculator}} to start the \highlight{\application{Calculator}} application.
786
236
  \end{flushleft}
787
237
\end{frame}
788
238
789
239
\begin{frame}
790
240
  \frametitle{GUI Elements}
791
241
  The list of current commands for \smallcaps{GUI} elements follows:
792
242
793
243
  \begingroup\ttfamily
794
244
  \begin{tabular}{ll}
795
245
    \string\button & \string\tab \\
796
246
    \string\dropdown & \string\checkbox \\
797
247
    \string\window & \string\keystroke \\
798
248
    \string\radiobutton & \string\textfield \\
799
249
    \string\application & \string\commandlineapp
800
250
  \end{tabular}
801
251
  \endgroup
802
252
803
253
  There are a few antiquated commands used in the manual that should be updated if you see them:
804
254
805
255
  Both \texttt{\string\menuitem} and \texttt{\string\nav} should be changed to \texttt{\string\menu}.
806
256
807
257
  \texttt{\string\option} should be changed to \texttt{\string\checkbox}.
808
258
\end{frame}
809
259
810
260
\begin{frame}
811
261
  \frametitle{Terminal Commands}
812
262
  There are also special commands for typesetting text that appears or is entered into a terminal.  An example will illustrate the commands:
813
263
814
264
  \begin{flushleft}
815
265
    \ttfamily
816
266
    The \string\commandlineapp\{fortune\} program works like this:\par
817
267
    \textbackslash begin\{terminal\}\\
818
268
    \space\space \textbackslash prompt\space\textbackslash userinput\{fortune\}\\
819
269
    What we have to learn to do we learn by doing.\\
820
270
    \ \ \  -- Aristotle, Ethica Nicomachea II (c. 325 BC)
821
271
    \textbackslash end\{terminal\}
822
272
  \end{flushleft}
823
273
824
274
  The above generates the following output:
825
275
826
276
  \begin{flushleft}
827
277
    \rmfamily
828
278
    The \commandlineapp{fortune} program works like this:\par
829
279
    \begingroup
830
280
    \parindent1em\parskip0pt\ttfamily\obeylines\obeyspaces
831
281
      \prompt \userinput{fortune}\par
832
282
      What we have to learn to do we learn by doing.\par
833
283
      \ \ \  -- Aristotle, Ethica Nicomachea II (c. 325 BC)
834
284
    \endgroup
835
285
  \end{flushleft}
836
286
\end{frame}
837
287
838
288
\begin{frame}
839
289
  \frametitle{Lists}
840
290
  There are two types of lists that we use in the manual: numbered lists and bulleted lists.  Both lists work the same way, they just have different names.
841
291
842
292
  \begin{minipage}{0.4\textwidth}
843
293
    \parskip\baselineskip
844
294
    \parindent0pt
845
295
    \begin{flushleft}
846
296
      \ttfamily
847
297
      \string\begin\{itemize\}\\
848
298
      \ \ \string\item\ First list item\\
849
299
      \ \ \string\item\ Second list item\\
850
300
      \ \ \string\item\ Third list item\\
851
301
      \string\end\{itemize\}
852
302
    \end{flushleft}
853
303
854
304
    produces:
855
305
856
306
    \begin{flushleft}
857
307
      \rmfamily
858
308
      \begin{itemize}
859
309
        \item First list item
860
310
        \item Second list item
861
311
        \item Third list item
862
312
      \end{itemize}
863
313
    \end{flushleft}
864
314
  \end{minipage}
865
315
  \hfill
866
316
  \begin{minipage}{0.4\textwidth}
867
317
    \parskip\baselineskip
868
318
    \parindent0pt
869
319
    \begin{flushleft}
870
320
      \ttfamily
871
321
      \string\begin\{enumerate\}\\
872
322
      \ \ \string\item\ First list item\\
873
323
      \ \ \string\item\ Second list item\\
874
324
      \ \ \string\item\ Third list item\\
875
325
      \string\end\{enumerate\}
876
326
    \end{flushleft}
877
327
878
328
    produces:
879
329
880
330
    \begin{flushleft}
881
331
      \rmfamily
882
332
      \begin{enumerate}
883
333
        \item First list item
884
334
        \item Second list item
885
335
        \item Third list item
886
336
      \end{enumerate}
887
337
    \end{flushleft}
888
338
  \end{minipage}
889
339
\end{frame}
890
340
891
341
\begin{frame}
892
342
  \frametitle{Cross-Referencing}
893
343
  You can refer the read to other chapters or sections for further information by using the \texttt{\string\chaplink} and \texttt{\string\seclink} commands.
894
344
895
345
  \begin{flushleft}
896
346
    \ttfamily
897
347
    Please see \highlight{\string\chaplink\{ch:installation\}} for more information on installing Ubuntu.
898
348
  \end{flushleft}
899
349
900
350
  generates:
901
351
902
352
  \begin{flushleft}
903
353
    \rmfamily
904
354
    Please see \highlight{\textbf{Chapter 1: Installation}} for more information on installing Ubuntu.
905
355
  \end{flushleft}
906
356
907
357
  The argument to the \texttt{\string\chaplink} and \texttt{\string\seclink} is a \emph{label}.  The label is set using the \texttt{\string\label} command immediately after the \texttt{\string\chapter} or \texttt{\string\section} command.
908
358
\end{frame}
909
359
910
360
\section{\protect\LaTeX{} for Translators}
911
361
912
362
\begin{frame}
913
363
  \frametitle{Notes for Translators}
914
364
  \LaTeX{} commands are preceded by a backslash character (\texttt{\textbackslash}).  While the command names should \emph{not} be translated, their arguments sometimes should be.
915
365
916
366
  In the following example, the red text should be translated, but the black text should be left as is:
917
367
918
368
  \begin{flushleft}
919
369
    \ttfamily
920
370
    \highlight{Click} \string\menu\{\highlight{Applications}\string\then\ \highlight{Accessories}\string\then\ \highlight{Calculator}\} \highlight{to start the} \string\application\{\highlight{Calculator}\} \highlight{application.}
921
371
  \end{flushleft}
922
372
923
373
  The labels in the \texttt{\string\chaplink}, \texttt{\string\seclink}, and \texttt{\string\ref} commands should never be translated.
924
374
\end{frame}
925
375
926
376
\section{For More Information}
927
377
928
378
\begin{frame}
929
379
  \vfill
930
380
  \begin{center}
931
381
    \Huge Questions?
932
382
  \end{center}
933
383
  \vfill
934
384
\end{frame}
935
385
936
386
\end{document}
937
387
938
388
939
0
389
940
=== added file 'Help/godbyk/latex-slides/ummacros.sty'
941
--- Help/godbyk/latex-slides/ummacros.sty	1970-01-01 00:00:00 +0000
942
+++ Help/godbyk/latex-slides/ummacros.sty	2014-09-01 04:44:23 +0000
943
@@ -0,0 +1,217 @@
944
1
%
945
2
% Idenfification
946
3
%
947
4
948
5
\NeedsTeXFormat{LaTeX2e}[1994/06/01]
949
6
950
7
\ProvidesClass{ummacros}[2010/02/21 v0.0.1 Ubuntu manual macros]
951
8
952
9
%
953
10
% Load packages
954
11
%
955
12
956
13
\RequirePackage{xifthen}
957
14
\RequirePackage[load=abbr,mode=text,alsoload=binary]{siunitx}% proper spacing and names for units
958
15
959
16
% A command that prints an interrupting dash.  Varies per language.  (For example, US is ``---'' without spacing, UK is `` -- '' with space.)
960
17
\newcommand{\dash}{\unskip\penalty0---\ignorespaces}
961
18
962
19
%
963
20
% Format the document style
964
21
%
965
22
966
23
% Ubuntu color palette
967
24
\definecolor{UbuntuOrange}              {HTML}{FF6309}% Ubuntu orange
968
25
\definecolor{UbuntuYellow}              {HTML}{FFB515}% Ubuntu yellow
969
26
\definecolor{UbuntuRed}                 {HTML}{C90016}% Ubuntu red
970
27
\definecolor{OrangeHilight}             {HTML}{EEC73E}% oranges
971
28
\definecolor{Orange}                    {HTML}{F0A513}
972
29
\definecolor{OrangeBase}                {HTML}{FB8B00}
973
30
\definecolor{OrangeShadow}              {HTML}{F44800}
974
31
\definecolor{AccentYellowHilight}       {HTML}{FDFF99}% yellows
975
32
\definecolor{Yellow}                    {HTML}{FFFF00}
976
33
\definecolor{AccentYellowBase}          {HTML}{FDCA01}
977
34
\definecolor{AccentYellowShadow}        {HTML}{986601}
978
35
\definecolor{AccentOrange}              {HTML}{F44800}% reds
979
36
\definecolor{AccentRed}                 {HTML}{FD3301}
980
37
\definecolor{AccentRedBase}             {HTML}{D40000}
981
38
\definecolor{AccentDeepRed}             {HTML}{980101}
982
39
\definecolor{HumanHighlight}            {HTML}{FDD99B}% skin tones
983
40
\definecolor{Human}                     {HTML}{D9BB7A}
984
41
\definecolor{HumanBase}                 {HTML}{816647}
985
42
\definecolor{EnvironmentalShadow}       {HTML}{565248}
986
43
\definecolor{EnvironmentalBlueHighlight}{HTML}{AACCEE}% environmental blues
987
44
\definecolor{EnvironmentalBlueMedium}   {HTML}{6699CC}
988
45
\definecolor{EnvironmentalBlueBase}     {HTML}{336699}
989
46
\definecolor{EnvironmentalBlueShadow}   {HTML}{003366}
990
47
\definecolor{AccentBlueHighlight}       {HTML}{B3DEFD}% accent blues
991
48
\definecolor{AccentBlue}                {HTML}{0197FD}
992
49
\definecolor{AccentBlueBase}            {HTML}{0169C9}
993
50
\definecolor{AccentBlueShadow}          {HTML}{013397}
994
51
\definecolor{AccentGreenHiglight}       {HTML}{CCFF99}% greens
995
52
\definecolor{AccentGreen}               {HTML}{98FC66}
996
53
\definecolor{AccentGreenBase}           {HTML}{339900}
997
54
\definecolor{AccentGreenShadow}         {HTML}{015A01}
998
55
\definecolor{UbuntuToner}               {HTML}{002B3D}% toner
999
56
\definecolor{AccentMagentHighlight}     {HTML}{FF9BFF}% magentas
1000
57
\definecolor{AccentMagenta}             {HTML}{FF00FF}
1001
58
\definecolor{AccentDarkViolet}          {HTML}{6600CC}
1002
59
1003
60
\definecolor{important}{HTML}{980101}% same as accent deep red
1004
61
1005
62
%
1006
63
% Define useful macros
1007
64
%
1008
65
1009
66
\newcommand{\notecallout}[2][Note]{%
1010
67
  \marginnote{\textbf{#1:} #2}
1011
68
}
1012
69
1013
70
\newcommand{\marginnote}[1]
1014
71
{%
1015
72
  \marginpar{%
1016
73
      %\begin{minipage}{\marginparwidth}%
1017
74
        \raggedright\sffamily\footnotesize%
1018
75
        \hspace{0pt}#1%
1019
76
      %\end{minipage}%
1020
77
  }%
1021
78
}
1022
79
1023
80
1024
81
% An environment for displaying terminal output
1025
82
% po4a: environment terminal
1026
83
\newenvironment{terminal}{%
1027
84
  \begin{quotation}
1028
85
    \unskip\noindent\ttfamily\parskip0pt\parindent0pt\obeylines\ignorespaces%
1029
86
}{%
1030
87
  \end{quotation}%
1031
88
}
1032
89
1033
90
% An environment to set the list of credits (names) in three columns.
1034
91
% po4a: environment credits
1035
92
\newenvironment{credits}[1][]{%
1036
93
  \begin{multicols}{3}[#1]%
1037
94
    \parskip0pt%
1038
95
    \parindent0pt%
1039
96
    \let\item\par%
1040
97
    \small%
1041
98
}{%
1042
99
  \end{multicols}%
1043
100
}
1044
101
1045
102
% Macros to distinguish prompts and user input from program output in terminal displays
1046
103
\newcommand{\prompt}{\texttt{\$}~}
1047
104
\newcommand{\rootprompt}{\texttt{\#}~}
1048
105
\newcommand{\userinput}[1]{{\ttfamily\textcolor{AccentDeepRed}{#1}}}% FIXME we'll adjust this formatting later -- red for easy editing at the moment
1049
106
\newcommand{\code}[1]{{\ttfamily#1}}
1050
107
1051
108
% Macro for advanced usage notes
1052
109
\newcommand{\advanced}[1]{%
1053
110
  \smallskip%
1054
111
  \begin{center}
1055
112
  \noindent%
1056
113
  \hspace{\parindent}%
1057
114
  \begin{minipage}[t]{0.25in}%
1058
115
    % FIXME \vspace{-\baselineskip}\includegraphics[width=0.25in]{warning.eps}\vspace{0pt}
1059
116
    \centering\Huge\textcolor{AccentDeepRed}{\textbf{!!}}
1060
117
  \end{minipage}%
1061
118
  \hfill%
1062
119
  \begin{minipage}[t]{\linewidth-0.5in}%
1063
120
    \vspace{-\baselineskip}\small\em#1%
1064
121
  \end{minipage}%
1065
122
  \hspace{\parindent}%
1066
123
  \end{center}
1067
124
  \smallskip\par%
1068
125
}
1069
126
1070
127
% Macro for warning notes
1071
128
\newcommand{\warning}[1]{%
1072
129
  \smallskip%
1073
130
  \begin{center}
1074
131
  \noindent%
1075
132
  \hspace{\parindent}%
1076
133
  \begin{minipage}[t]{0.25in}%
1077
134
    % FIXME \vspace{-\baselineskip}\includegraphics[width=0.25in]{warning.eps}\vspace{0pt}
1078
135
    \centering\Huge\textcolor{AccentDeepRed}{\textbf{!}}
1079
136
  \end{minipage}%
1080
137
  \hfill%
1081
138
  \begin{minipage}[t]{\linewidth-0.5in}%
1082
139
    \vspace{-\baselineskip}\small\em#1%
1083
140
  \end{minipage}%
1084
141
  \hspace{\parindent}%
1085
142
  \end{center}
1086
143
  \smallskip\par%
1087
144
}
1088
145
1089
146
1090
147
% Macro for typesetting menu selection sequences.
1091
148
% \nav{Menu \then Submenu \then Subsubmenu} would generate text looking like
1092
149
% ``Menu --> Submenu --> Subsubmenu''.
1093
150
%\newcommand{\smallarrow}{\raisebox{0.333ex}{\scalebox{0.5}{\ding{228}}}}
1094
151
\@ifpackageloaded{fontspec}{%
1095
152
  \newcommand{\smallarrow}{‣}%
1096
153
}{%
1097
154
  \newcommand{\smallarrow}{\raisebox{0.250ex}{\scalebox{0.5}{\ding{228}}}}
1098
155
}
1099
156
\newcommand{\nav}[1]{%
1100
157
  \begingroup%
1101
158
    %\def\then{\unskip\ensuremath{\,\rightarrow\,}\ignorespaces}%
1102
159
    \def\then{\unskip\,\smallarrow\,\allowbreak\ignorespaces}%
1103
160
    \textbf{#1}%
1104
161
  \endgroup%
1105
162
}
1106
163
1107
164
% Macro to format application names and index them
1108
165
\newcommand{\application}[1]{%
1109
166
  \textbf{#1}%
1110
167
  \index{#1}\index{applications!#1}%
1111
168
}
1112
169
1113
170
% Macro to format command line programs and index them
1114
171
\newcommand{\commandlineapp}[1]{%
1115
172
  \textbf{#1}%
1116
173
  \index{#1}\index{command line!#1}%
1117
174
}
1118
175
1119
176
% Macro to simplify linking to chapters
1120
177
\newcommand{\chaplink}[1]{%
1121
178
  % not using \autoref here because I don't want to fix the case of \chapterautorefname for individual languages --godbyk
1122
179
  \IfBeforeSubStringEmpty{ch:}{#1}{\hyperref[#1]{\@chapapp~}\ref{#1}\hyperref[#1]{: }\nameref{#1}}{\hyperref[ch:#1]{\@chapapp~}\ref{ch:#1}\hyperref[ch:#1]{: }\nameref{ch:#1}}%
1123
180
}
1124
181
1125
182
% Macro to simplify linking to sections
1126
183
\newcommand{\seclink}[1]{%
1127
184
  %\IfBeforeSubStringEmpty{sec:}{#1}{\autoref{#1}\hyperref[#1]{: }\nameref{#1}}{\autoref{sec:#1}\hyperref[sec:#1]{: }\nameref{sec:#1}}%
1128
185
  \IfBeforeSubStringEmpty{sec:}{#1}{\nameref{#1}}{\nameref{sec:#1}}%
1129
186
}
1130
187
1131
188
% Macros to format UI elements
1132
189
\newcommand{\button}[1]{\textbf{#1}}
1133
190
\newcommand{\tab}[1]{\textbf{#1}}
1134
191
\newcommand{\dropdown}[1]{\textbf{#1}}
1135
192
\newcommand{\checkbox}[1]{\textbf{#1}}
1136
193
\newcommand{\menuitem}[1]{\textbf{#1}}
1137
194
\newcommand{\window}[1]{``#1''}
1138
195
\newcommand{\keystroke}[1]{\texttt{#1}}
1139
196
\newcommand{\radiobutton}[1]{\textbf{#1}}
1140
197
\newcommand{\textfield}[1]{\textbf{#1}}
1141
198
\newcommand{\option}[1]{\enquote{#1}}
1142
199
\let\menu\nav
1143
200
1144
201
% Screenshot placeholder
1145
202
\newcommand*{\screenshotslog}{screenshots.log}
1146
203
\newwrite\screenshots
1147
204
\newcommand{\screenshotTODO}[1]{%
1148
205
  \immediate\write\screenshots{Chapter \thechapter, page \thepage: #1}%
1149
206
  %\immediate\closeout\screenshots%
1150
207
  \par\noindent\parbox{\linewidth}{\begin{center}\sffamily\bfseries\color{important} M~I~S~S~I~N~G~~~S~C~R~E~E~N~S~H~O~T\par\medskip\footnotesize\normalcolor#1\end{center}}\par%
1151
208
}
1152
209
\AtBeginDocument{\immediate\openout\screenshots=\screenshotslog}% open the screenshots.log file
1153
210
\AtEndDocument{\immediate\closeout\screenshots}% close the screenshots.log file
1154
211
1155
212
%
1156
213
% All done!
1157
214
%
1158
215
1159
216
\endinput
1160
217
1161
0
218
1162
=== added file 'Help/groundcontrol.pdf'
1163
1
Binary files Help/groundcontrol.pdf	1970-01-01 00:00:00 +0000 and Help/groundcontrol.pdf	2014-09-01 04:44:23 +0000 differ
219
Binary files Help/groundcontrol.pdf	1970-01-01 00:00:00 +0000 and Help/groundcontrol.pdf	2014-09-01 04:44:23 +0000 differ
1164
=== added file 'Help/intro.pdf'
1165
2
Binary files Help/intro.pdf	1970-01-01 00:00:00 +0000 and Help/intro.pdf	2014-09-01 04:44:23 +0000 differ
220
Binary files Help/intro.pdf	1970-01-01 00:00:00 +0000 and Help/intro.pdf	2014-09-01 04:44:23 +0000 differ
1166
=== added file 'Help/launchpad.pdf'
1167
3
Binary files Help/launchpad.pdf	1970-01-01 00:00:00 +0000 and Help/launchpad.pdf	2014-09-01 04:44:23 +0000 differ
221
Binary files Help/launchpad.pdf	1970-01-01 00:00:00 +0000 and Help/launchpad.pdf	2014-09-01 04:44:23 +0000 differ
1168
=== added file 'Help/socialmedia.pdf'
1169
4
Binary files Help/socialmedia.pdf	1970-01-01 00:00:00 +0000 and Help/socialmedia.pdf	2014-09-01 04:44:23 +0000 differ
222
Binary files Help/socialmedia.pdf	1970-01-01 00:00:00 +0000 and Help/socialmedia.pdf	2014-09-01 04:44:23 +0000 differ
1170
=== added file 'Help/writingstyle.pdf'
1171
5
Binary files Help/writingstyle.pdf	1970-01-01 00:00:00 +0000 and Help/writingstyle.pdf	2014-09-01 04:44:23 +0000 differ
223
Binary files Help/writingstyle.pdf	1970-01-01 00:00:00 +0000 and Help/writingstyle.pdf	2014-09-01 04:44:23 +0000 differ
1172
=== added file 'Makefile'
1173
--- Makefile	1970-01-01 00:00:00 +0000
1174
+++ Makefile	2014-09-01 04:44:23 +0000
1175
@@ -0,0 +1,242 @@
1176
1
LATEXFILE=main
1177
2
1178
3
.PHONY: translations clean show all mylang show-mylang
1179
4
SHELL=/bin/bash
1180
5
1181
6
all: $(LATEXFILE).pdf
1182
7
1183
8
CHAPTERS=\
1184
9
	frontmatter/*.tex \
1185
10
	around-desktop/*.tex \
1186
11
	backmatter/*.tex \
1187
12
	command-line/*.tex \
1188
13
	credits/*.tex \
1189
14
	default-apps/*.tex \
1190
15
	installation/*.tex \
1191
16
	learning-more/*.tex \
1192
17
	maintenance/maintenance.tex \
1193
18
	prefs-hardware/*.tex \
1194
19
	prologue/*.tex \
1195
20
	security/*.tex \
1196
21
	software-packaging/*.tex \
1197
22
	troubleshooting/*.tex
1198
23
1199
24
1200
25
$(LATEXFILE).pdf: $(LATEXFILE).tex ubuntu-manual.cls $(CHAPTERS) revinfo
1201
26
	xelatex --output-driver="xdvipdfmx -V 5" $(LATEXFILE)
1202
27
	xelatex --output-driver="xdvipdfmx -V 5" $(LATEXFILE)
1203
28
	makeglossaries -L english $(LATEXFILE)
1204
29
	makeindex $(LATEXFILE)
1205
30
	xelatex --output-driver="xdvipdfmx -V 5" $(LATEXFILE)
1206
31
	makeglossaries -L english $(LATEXFILE)
1207
32
	xelatex --output-driver="xdvipdfmx -V 5" $(LATEXFILE)
1208
33
	xelatex --output-driver="xdvipdfmx -V 5" $(LATEXFILE)
1209
34
	xelatex --output-driver="xdvipdfmx -V 5" $(LATEXFILE)
1210
35
	$(color_tex) $(LATEXFILE).log
1211
36
1212
37
check: $(LATEXFILE).pdf
1213
38
	$(color_tex) $(LATEXFILE).log
1214
39
1215
40
style-guide.pdf: style-guide.tex ubuntu-manual.cls
1216
41
	xelatex --output-driver="xdvipdfmx -V 5" style-guide
1217
42
	xelatex --output-driver="xdvipdfmx -V 5" style-guide
1218
43
	makeglossaries -L english style-guide
1219
44
	makeindex style-guide
1220
45
	xelatex --output-driver="xdvipdfmx -V 5" style-guide
1221
46
	makeglossaries -L english style-guide
1222
47
	xelatex --output-driver="xdvipdfmx -V 5" style-guide
1223
48
	xelatex --output-driver="xdvipdfmx -V 5" style-guide
1224
49
	xelatex --output-driver="xdvipdfmx -V 5" style-guide
1225
50
	$(color_tex) style-guide.log
1226
51
1227
52
1228
53
# Handle translations
1229
54
TRANSLATIONS=$(shell for PO in po/*.po; do basename $$PO .po; done) # list of languages in the po/ dir
1230
55
TRANSLATIONS_TEX=$(foreach PO, $(TRANSLATIONS), ubuntu-manual-$(shell basename $(PO) .po).tex) # list of .tex files to be generated
1231
56
TRANSLATIONS_PDF=$(foreach PO, $(TRANSLATIONS), ubuntu-manual-$(shell basename $(PO) .po).pdf) # list of .pdf files to be generated
1232
57
1233
58
# Default translation is en_US
1234
59
ubuntu-manual-en_US.pdf: $(LATEXFILE).pdf
1235
60
	cp $(LATEXFILE).pdf $@
1236
61
1237
62
# Compile all translations at once
1238
63
translations: $(TRANSLATIONS_PDF) ubuntu-manual.cls
1239
64
1240
65
LLANG=$(shell echo $${LANG} | sed -e 's/\..*$$//g')
1241
66
SLANG=$(shell echo $${LANG} | sed -e 's/_.*$$//g')
1242
67
MYLANG=$(shell for PO in ${TRANSLATIONS}; do if [ "$${PO}" == "${LLANG}" ]; then echo ${LLANG}; exit 0; elif [ "$${PO}" == "${SLANG}" ]; then echo ${SLANG}; exit 0; fi; done; echo "en_US")
1243
68
1244
69
# Compile the pdf for the current system language (if there's an appropriate translation)
1245
70
mylang: ubuntu-manual-${MYLANG}.pdf
1246
71
1247
72
%.tex: revinfo
1248
73
	po4a-translate --master-charset=utf8 -f latex -m main.tex -p $(subst .tex,.po,$(subst ubuntu-manual-,po/,$@)) -l $@ -k 0
1249
74
1250
75
%.tex: %.po ubuntu-manual.cls revinfo
1251
76
	po4a-translate --master-charset=utf8 -f latex -m main.tex -p $< -l ubuntu-manual-$(shell basename $< .po).tex -k 0
1252
77
1253
78
%.pdf: POLANG=$(shell basename $(subst ubuntu-manual-,,$<) .tex)
1254
79
%.pdf: TEXFILE=$(shell basename $< .tex)
1255
80
%.pdf: XINDYLANG=$(shell grep -v "^#" langcodes.txt | grep "^${POLANG}" | awk '{ print $$3 }' || echo -n "general")
1256
81
1257
82
%.pdf: %.tex ubuntu-manual.cls revinfo
1258
83
	#$(call generate_titlepage,${POLANG})
1259
84
	xelatex --output-driver="xdvipdfmx -V 5" -interaction nonstopmode "\def\polang{${POLANG}}\input{${TEXFILE}}"
1260
85
	xelatex --output-driver="xdvipdfmx -V 5" -interaction nonstopmode "\def\polang{${POLANG}}\input{${TEXFILE}}"
1261
86
	makeglossaries -L ${XINDYLANG} ${TEXFILE}
1262
87
	#texindy -L ${XINDYLANG} -C utf8 ${TEXFILE}.idx
1263
88
	xindy -C utf8 -M texindy -L ${XINDYLANG} ${TEXFILE}.idx
1264
89
	xelatex --output-driver="xdvipdfmx -V 5" -interaction nonstopmode '\def\polang{$(POLANG)}\input{$(TEXFILE)}'
1265
90
	makeglossaries -L ${XINDYLANG} $(TEXFILE)
1266
91
	xelatex --output-driver="xdvipdfmx -V 5" -interaction nonstopmode '\def\polang{$(POLANG)}\input{$(TEXFILE)}'
1267
92
	xelatex --output-driver="xdvipdfmx -V 5" -interaction nonstopmode '\def\polang{$(POLANG)}\input{$(TEXFILE)}'
1268
93
	xelatex --output-driver="xdvipdfmx -V 5" -interaction nonstopmode '\def\polang{$(POLANG)}\input{$(TEXFILE)}'
1269
94
	$(color_tex) $(TEXFILE).log
1270
95
1271
96
revinfo:
1272
97
	bzr version-info --custom --template="\\\noindent\\\revinfo{{revno}}{{date}}" > revision.tex
1273
98
1274
99
1275
100
generate_titlepage = \
1276
101
	inkscape --export-text-to-path --export-pdf=titlepage/titlepage-$(1).pdf titlepage/titlepage-$(1).svg
1277
102
1278
103
#titlepage/titlepage-%.pdf: titlepage/titlepage-%.svg
1279
104
#	inkscape --export-text-to-path --export-pdf=$(subst .svg,.pdf,$<) $<
1280
105
1281
106
%.pdf: %.asy
1282
107
	asy -f pdf $<
1283
108
1284
109
%.pdf: %.svg
1285
110
	inkscape --export-text-to-path --export-pdf=$@ $<
1286
111
	#pdfcrop $@ $@
1287
112
1288
113
%.png: %.dot
1289
114
	dot -v -Tpng $< -o $@
1290
115
1291
116
show: $(LATEXFILE).pdf
1292
117
	evince $<
1293
118
1294
119
show-mylang: ubuntu-manual-${MYLANG}.pdf
1295
120
	evince $<
1296
121
1297
122
clean:
1298
123
	-rm -fr $(LATEXFILE).aux $(LATEXFILE).log $(LATEXFILE).nav $(LATEXFILE).out $(LATEXFILE).pdf $(LATEXFILE).snm $(LATEXFILE).toc
1299
124
	-rm -fr $(LATEXFILE).idx $(LATEXFILE).ilg $(LATEXFILE).ind $(LATEXFILE).lof $(LATEXFILE).lot
1300
125
	-rm -fr $(LATEXFILE).glg $(LATEXFILE).glo $(LATEXFILE).gls $(LATEXFILE).xdy
1301
126
	-rm -f missfont.log
1302
127
	-rm -f */*.aux
1303
128
	-rm -f */*.log
1304
129
	-rm -f *.bbl *.blg */*.bbl */*.blg # biblio files
1305
130
	-rm -f *.ptc # titletoc
1306
131
	-rm -f ubuntu-manual-* # translated files
1307
132
1308
133
1309
134
#
1310
135
# From Chris Monson's LaTeX Makefile
1311
136
#
1312
137
1313
138
SED		?= sed
1314
139
TPUT	?= tput
1315
140
1316
141
tput	= $(shell $(TPUT) $1)
1317
142
1318
143
black	:= $(call tput,setaf 0)
1319
144
red	:= $(call tput,setaf 1)
1320
145
green	:= $(call tput,setaf 2)
1321
146
yellow	:= $(call tput,setaf 3)
1322
147
blue	:= $(call tput,setaf 4)
1323
148
magenta	:= $(call tput,setaf 5)
1324
149
cyan	:= $(call tput,setaf 6)
1325
150
white	:= $(call tput,setaf 7)
1326
151
bold	:= $(call tput,bold)
1327
152
uline	:= $(call tput,smul)
1328
153
reset	:= $(call tput,sgr0)
1329
154
1330
155
#
1331
156
# User-settable definitions
1332
157
#
1333
158
LATEX_COLOR_WARNING	?= magenta
1334
159
LATEX_COLOR_ERROR	?= red
1335
160
LATEX_COLOR_INFO	?= green
1336
161
LATEX_COLOR_UNDERFULL	?= magenta
1337
162
LATEX_COLOR_OVERFULL	?= red bold
1338
163
LATEX_COLOR_PAGES	?= bold
1339
164
LATEX_COLOR_BUILD	?= blue
1340
165
LATEX_COLOR_GRAPHIC	?= yellow
1341
166
LATEX_COLOR_DEP		?= green
1342
167
LATEX_COLOR_SUCCESS	?= green bold
1343
168
LATEX_COLOR_FAILURE	?= red bold
1344
169
1345
170
# Gets the real color from a simple textual definition like those above
1346
171
# $(call get-color,ALL_CAPS_COLOR_NAME)
1347
172
# e.g., $(call get-color,WARNING)
1348
173
get-color	= $(subst $(space),,$(foreach c,$(LATEX_COLOR_$1),$($c)))
1349
174
1350
175
#
1351
176
# STANDARD COLORS
1352
177
#
1353
178
C_WARNING	:= $(call get-color,WARNING)
1354
179
C_ERROR		:= $(call get-color,ERROR)
1355
180
C_INFO		:= $(call get-color,INFO)
1356
181
C_UNDERFULL	:= $(call get-color,UNDERFULL)
1357
182
C_OVERFULL	:= $(call get-color,OVERFULL)
1358
183
C_PAGES		:= $(call get-color,PAGES)
1359
184
C_BUILD		:= $(call get-color,BUILD)
1360
185
C_GRAPHIC	:= $(call get-color,GRAPHIC)
1361
186
C_DEP		:= $(call get-color,DEP)
1362
187
C_SUCCESS	:= $(call get-color,SUCCESS)
1363
188
C_FAILURE	:= $(call get-color,FAILURE)
1364
189
C_RESET		:= $(reset)
1365
190
1366
191
1367
192
1368
193
color_tex	:= \
1369
194
	@$(SED) \
1370
195
	-e '$${' \
1371
196
	-e '  /^$$/!{' \
1372
197
	-e '    H' \
1373
198
	-e '    s/.*//' \
1374
199
	-e '  }' \
1375
200
	-e '}' \
1376
201
	-e '/^$$/!{' \
1377
202
	-e '  H' \
1378
203
	-e '  d' \
1379
204
	-e '}' \
1380
205
	-e '/^$$/{' \
1381
206
	-e '  x' \
1382
207
	-e '  s/^\n//' \
1383
208
	-e '  /Output written/{' \
1384
209
	-e '    s/.*(\([^)]\{1,\}\)).*/Success!  Wrote \1/' \
1385
210
	-e '    s/[[:digit:]]\{1,\}/$(C_PAGES)&$(C_RESET)/g' \
1386
211
	-e '    s/Success!/$(C_SUCCESS)&$(C_RESET)/g' \
1387
212
	-e '    b end' \
1388
213
	-e '  }' \
1389
214
	-e '  /! *LaTeX Error:.*/{' \
1390
215
	-e '    s/.*\(! *LaTeX Error:.*\)/$(C_ERROR)\1$(C_RESET)/' \
1391
216
	-e '    b end' \
1392
217
	-e '  }' \
1393
218
	-e '  /.*Warning: Marginpar on page [0-9]\+ moved\./{' \
1394
219
	-e '    s//$(C_RESET)&$(C_RESET)/' \
1395
220
	-e '    b end' \
1396
221
	-e '  }' \
1397
222
	-e '  /.*Warning: Reference .*/{' \
1398
223
	-e '    s//$(C_ERROR)&$(C_RESET)/' \
1399
224
	-e '    b end' \
1400
225
	-e '  }' \
1401
226
	-e '  /.*Warning:.*/{' \
1402
227
	-e '    s//$(C_WARNING)&$(C_RESET)/' \
1403
228
	-e '    b end' \
1404
229
	-e '  }' \
1405
230
	-e '  /Underfull.*/{' \
1406
231
	-e '    s/.*\(Underfull.*\)/$(C_UNDERFULL)\1$(C_RESET)/' \
1407
232
	-e '    b end' \
1408
233
	-e '  }' \
1409
234
	-e '  /Overfull.*/{' \
1410
235
	-e '    s/.*\(Overfull.*\)/$(C_OVERFULL)\1$(C_RESET)/' \
1411
236
	-e '    b end' \
1412
237
	-e '  }' \
1413
238
	$(if $(VERBOSE),,-e '  d') \
1414
239
	-e '  :end' \
1415
240
	-e '  G' \
1416
241
	-e '}' \
1417
242
1418
0
243
1419
=== renamed file 'Makefile' => 'Makefile.moved'
1420
=== added file 'Makefile.orig'
1421
--- Makefile.orig	1970-01-01 00:00:00 +0000
1422
+++ Makefile.orig	2014-09-01 04:44:23 +0000
1423
@@ -0,0 +1,3142 @@
1424
1
# Copyright 2004 Chris Monson (shiblon@gmail.com)
1425
2
# Latest version available at http://www.bouncingchairs.net/oss
1426
3
#
1427
4
#    This file is part of ``Chris Monson's Free Software''.
1428
5
#
1429
6
#    ``Chris Monson's Free Software'' is free software; you can redistribute it
1430
7
#    and/or modify it under the terms of the GNU General Public License as
1431
8
#    published by the Free Software Foundation, Version 2.
1432
9
#
1433
10
#    ``Chris Monson's Free Software'' is distributed in the hope that it will
1434
11
#    be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
1435
12
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
1436
13
#    Public License for more details.
1437
14
#
1438
15
#    You should have received a copy of the GNU General Public License along
1439
16
#    with ``Chris Monson's Free Software''; if not, write to the Free Software
1440
17
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
1441
18
#
1442
19
#    It is also available on the web at http://www.gnu.org/copyleft/gpl.html
1443
20
#
1444
21
#    Note that using this makefile to build your documents does NOT place them
1445
22
#    under the GPL unless you, the author, specifically do so.  In other words,
1446
23
#    I, Chris Monson, the copyright holder and author of this makefile,
1447
24
#    consider it impossible to ``link'' to this makefile in any way covered by
1448
25
#    the GPL.
1449
26
#
1450
27
# TO OBTAIN INSTRUCTIONS FOR USING THIS FILE, RUN:
1451
28
#    make help
1452
29
#
1453
30
fileinfo	:= LaTeX Makefile
1454
31
author		:= Chris Monson
1455
32
version		:= 2.1.40
1456
33
#
1457
34
# If you specify sources here, all other files with the same suffix
1458
35
# will be treated as if they were _include_ files.
1459
36
#onlysources.tex	?= main.tex
1460
37
#onlysources.tex.sh	?=
1461
38
#onlysources.rst	?=
1462
39
#onlysources.fig	?=
1463
40
#onlysources.gpi	?=
1464
41
#onlysources.dot	?=
1465
42
#onlysources.xvg	?=
1466
43
#onlysources.svg	?=
1467
44
#onlysources.eps.gz	?=
1468
45
#onlysources.eps	?=
1469
46
#
1470
47
# If you list files here, they will be treated as _include_ files
1471
48
#includes.tex		?= file1.tex file2.tex
1472
49
#includes.tex.sh	?=
1473
50
#includes.rst		?=
1474
51
#includes.fig		?=
1475
52
#includes.gpi		?=
1476
53
#includes.dot		?=
1477
54
#includes.xvg		?=
1478
55
#includes.svg		?=
1479
56
#includes.eps.gz	?=
1480
57
#includes.eps		?=
1481
58
#
1482
59
# If you list files or wildcards here, they will *not* be cleaned - default is
1483
60
# to allow everything to be cleaned.
1484
61
#neverclean		?= *.pdf
1485
62
#
1486
63
# Alternatively (recommended), you can add those lines to a Makefile.ini file
1487
64
# and it will get picked up automatically without your having to edit this
1488
65
# Makefile.
1489
66
-include Makefile.ini
1490
67
1491
68
# TODO:
1492
69
# 	* Sometimes we get
1493
70
# 		"mv: cannot stat '*.dvi.1st.make': No such file or directory"
1494
71
# 		 on the second build (if nothing triggered a .d rebuild, but
1495
72
# 		 the .dvi rule fired anyway).  To reproduce in the
1496
73
# 		 dissertation directory:
1497
74
#
1498
75
#		 make clean
1499
76
# 		 make byumsphd-example
1500
77
# 		 make byumsphd-example
1501
78
#
1502
79
# KNOWN ISSUES:
1503
80
#	* The following occurs:
1504
81
#		file with: \usepackage{named}\bibliographystyle{named}
1505
82
#		Compile
1506
83
#		change to: \usepackage{apalike}\bibliographystyle{apalike}
1507
84
#		Compile again -- BARF!
1508
85
#
1509
86
#		The workaround: make clean-nographics; make
1510
87
#
1511
88
#		Note that we may not be able to fix this.  LaTeX itself barfs
1512
89
#		on this, not the makefile.  The very first invocation of LaTeX
1513
90
#		(when something like this has happened) reads the existing .aux
1514
91
#		file and discovers invalid commands like \citeauthoryear that
1515
92
#		are only valid in the package that was just removed.  It then
1516
93
#		tries to parse them and explodes.  It's not at all clear to me
1517
94
#		how to fix this.  I tried removing the .aux files on the first
1518
95
#		run of LaTeX, but that necessarily requires more subsequent
1519
96
#		rebuilds on common edits.  There does not appear to be a
1520
97
#		graceful solution to this issue.
1521
98
#
1522
99
# CHANGES:
1523
100
# Chris Monson (2009-12-01):
1524
101
# 	* Bumped version to 2.1.40
1525
102
# 	* issue 36: build all indices (for e.g., splitidx usage)
1526
103
# 	* issue 59: clean up all generated files (including indices)
1527
104
# Chris Monson (2009-11-23):
1528
105
# 	* Bumped version to 2.1.39
1529
106
# 	* issue 57: change ps2pdf invocations to just use gs directly
1530
107
# Chris Monson (2009-11-19):
1531
108
# 	* Bumped version to 2.1.38
1532
109
# 	* issue 57: Added some limited support for Cygwin (spaces in filenames)
1533
110
# Chris Monson (2009-11-15):
1534
111
# 	* Bumped version to 2.1.37
1535
112
# 	* Removed svninfo, since this is now managed by mercurial
1536
113
# 	* Fixed typo in changelist
1537
114
# 	* Issue 52: added jpg->eps conversion (thanks to brubakee)
1538
115
# 	* Issue 54: fix missing Overfull colorization due to lack of a blank
1539
116
# 		line preceding the first error.
1540
117
#	* Issue 51: remove head.tmp and body.tmp in make clean invocation
1541
118
#	* Issue 56: maintain multiple versions of log files (for debugging)
1542
119
# Chris Monson (2009-11-14):
1543
120
# 	* Bumped version to 2.1.36
1544
121
# 	* Issues 53 and 49: added .brf, .mtc, and .maf to the cleanables
1545
122
# Chris Monson (2009-11-05):
1546
123
# 	* Bumped version to 2.1.35
1547
124
# 	* Added nomenclature support (see issue 48)
1548
125
# Chris Monson (2009-10-29):
1549
126
# 	* Bumped version to 2.1.34
1550
127
# 	* Fixed _out_ creation bug introduced in 2.1.33 (it was always created)
1551
128
# 	* Fixed erroneous help output for $HOME in BINARY_TARGET_DIR
1552
129
# 	* Changed contact email address - bring on the spam!
1553
130
# Chris Monson (2009-10-21):
1554
131
# 	* Bumped version to 2.1.33
1555
132
# 	* Fixed issue 46, adding support for dot2tex (thanks to fdemesmay)
1556
133
# 	* Made all_files.* settable in Makefile.ini (using ?= instead of :=)
1557
134
# 	* Fixed issue 47, thanks to fdemesmay: add binary copy directory, copy
1558
135
# 		dvi, pdf, and ps if it exists
1559
136
# Chris Monson (2009-09-25):
1560
137
# 	* Bumped version to 2.1.32
1561
138
# 	* Fixed so that a changed lol file will cause a rebuild
1562
139
# 	* Added .lol files to the cleanable list
1563
140
# Chris Monson (2009-09-08):
1564
141
# 	* Bumped version to 2.1.31
1565
142
# 	* Closed issue 43: evince doesn't notice pdf change w/out touch
1566
143
# Chris Monson (2009-08-28):
1567
144
# 	* Bumped version to 2.1.30
1568
145
# 	* Closed issue 39: Capture multi-line log warnings/errors to output
1569
146
# Chris Monson (2009-08-26):
1570
147
# 	* Bumped version to 2.1.29
1571
148
# 	* Closed issue 42: add svg support using inkscape
1572
149
# Chris Monson (2009-08-17):
1573
150
# 	* Bumped version to 2.1.28
1574
151
# 	* Patch from paul.biggar for issue 38: package warnings are overlooked
1575
152
# Chris Monson (2009-08-07):
1576
153
# 	* Bumped version to 2.1.27
1577
154
# 	* Included patch for issue 37 - removes pdf/ps files before copying,
1578
155
# 		allowing some broken viewers to see changes properly.
1579
156
# Chris Monson (2009-05-15):
1580
157
# 	* Bumped version to 2.1.26
1581
158
# 	* Included patch for issue 9 from favonia - detects .fig changes for
1582
159
# 		pstex files during regular compilation, so long as the pstex
1583
160
# 		has been built at least once with make all-pstex.
1584
161
# Chris Monson (2009-03-27):
1585
162
# 	* Bumped version to 2.1.25
1586
163
# 	* Cleaned up a bunch of variable setting stuff - more stuff is now
1587
164
# 		settable from Makefile.ini
1588
165
# 	* Cleaned up documentation for various features, especially settable
1589
166
# 		variables.
1590
167
# 	* issue 28: support for png -> eps conversion (it even looks good!)
1591
168
# 	* issue 29: support for "neverclean" files in Makefile.ini
1592
169
# 	* issue 30: make ps2pdf14 the default - fall back when not there
1593
170
# Chris Monson (2009-03-09):
1594
171
# 	* Bumped version to 2.1.24
1595
172
# 	* issue 27: xmgrace support (thanks to rolandschulzhd)
1596
173
# Chris Monson (2008-10-23):
1597
174
# 	* Bumped version to 2.1.23
1598
175
# 	* issue 23: fixed _check_programs to not use bash string subs
1599
176
# Chris Monson (2008-09-02):
1600
177
# 	* Bumped version to 2.1.22
1601
178
# 	* Appled patch from Holger <yllohy@googlemail.com> to add include
1602
179
# 		sources and some documentation updates.
1603
180
# 	* Updated backup_patterns to be a bit more aggressive (also thanks to
1604
181
# 		Holger)
1605
182
# Chris Monson (2008-08-30):
1606
183
# 	* Bumped version to 2.1.21
1607
184
# 	* Added ability to specify onlysources.* variables to indicate the only
1608
185
# 		files that should *not* be considered includes.  Thanks to Holger
1609
186
# 		<yllohy@googlemail.com> for this patch.
1610
187
# 	* Added an automatic include of Makefile.ini if it exists.  Allows
1611
188
# 		settings to be made outside of this makefile.
1612
189
# Chris Monson (2008-05-21):
1613
190
# 	* Bumped version to 2.1.20
1614
191
# 	* Added manual pstex compilation support (run make all-pstex first)
1615
192
# 	* Removed all automatic pstex support.  It was totally breaking
1616
193
# 		everything and is very hard to incorporate into the makefile
1617
194
# 		concept because it requires LaTeX to *fail* before it can
1618
195
# 		determine that it needs the files.
1619
196
# Chris Monson (2008-04-17):
1620
197
# 	* Bumped version to 2.1.19
1621
198
# 	* Changed the pstex build hack to be on by default
1622
199
# Chris Monson (2008-04-09):
1623
200
# 	* Bumped version to 2.1.18
1624
201
# 	* issue 16: fixed pstex build problems, seems nondeterministic.  Added
1625
202
# 		gratuitious hack for testing: set PSTEX_BUILD_ALL_HACK=1.
1626
203
# Chris Monson (2008-04-09):
1627
204
# 	* Bumped version to 2.1.17
1628
205
# 	* issue 20: fixed accumulation of <pid>*.make files - wildcard was
1629
206
#		refusing to work on files that are very recently created.
1630
207
# Chris Monson (2008-04-02):
1631
208
# 	* Bumped version to 2.1.16
1632
209
# 	* issue 19: Removed the use of "type" to fix broken "echo" settings
1633
210
# Chris Monson (2008-03-27):
1634
211
# 	* Bumped version to 2.1.15
1635
212
# 	* issue 18: Favors binary echo over builtin, as binary understands -n
1636
213
# 	* issue 16: Fixed handling of missing pstex_t files in the log
1637
214
# 	* issue 9: Added .SECONDARY target for .pstex files
1638
215
# Chris Monson (2008-03-21):
1639
216
# 	* Bumped version to 2.1.14
1640
217
# 	* Fixed broken aux file flattening, which caused included bibs to be
1641
218
# 		missed.
1642
219
# Chris Monson (2008-03-20):
1643
220
# 	* Bumped version to 2.1.13
1644
221
# 	* Changed error output colorization to show errors for missing files
1645
222
# 		that are not graphics files.
1646
223
# Chris Monson (2008-03-20):
1647
224
# 	* Bumped version to 2.1.12
1648
225
# 	* Fixed a regression introduced in r28 that makes bibtex fail when
1649
226
# 		there is no index file present
1650
227
# Chris Monson (2008-03-03):
1651
228
# 	* Bumped version to 2.1.11
1652
229
# 	* Fixed issue 11 (handle index files, reported by abachn)
1653
230
# 	* Cleaned up some comments and help text
1654
231
# Chris Monson (2008-01-24):
1655
232
# 	* Bumped version to 2.1.10
1656
233
#	* Fixed to work when 'sh' is a POSIX shell like 'dash'
1657
234
# Chris Monson (2007-12-12):
1658
235
# 	* Bumped version to 2.1.9
1659
236
# 	* Fixed documentation and dependency graph for pstex files
1660
237
# Chris Monson (2007-12-12):
1661
238
# 	* Bumped version to 2.1.8
1662
239
# 	* Added basic pstex_t support for fig files (Issue 9 by favonia)
1663
240
# 		I still suggest that psfrag be used instead.
1664
241
# Chris Monson (2007-10-16):
1665
242
# 	* Bumped version to 2.1.7
1666
243
# 	* Removed todo item: allow other comment directives for rst conversion
1667
244
# 	* Added ability to use global rst style file _rststyle_._include_.tex
1668
245
# 	* Added help text to that effect
1669
246
# Chris Monson (2007-05-20):
1670
247
# 	* Bumped version to 2.1.6
1671
248
# 	* Changed default paper size for rst files
1672
249
# 	* Added todo item: fix paper size for rst files
1673
250
# 	* Added todo item: allow other comment directives for rst conversion
1674
251
# Chris Monson (2007-04-02):
1675
252
# 	* Bumped version to 2.1.5
1676
253
# 	* Addressed Issue 7, incorrect .gpi.d generation in subdirectories
1677
254
# Chris Monson (2007-03-28):
1678
255
# 	* Bumped version to 2.1.4
1679
256
# 	* Fixed syntax error in dot output
1680
257
# Chris Monson (2007-03-01):
1681
258
# 	* Bumped version to 2.1.3
1682
259
# 	* Added reST to the included documentation
1683
260
# 	* Fixed graphics and script generation to be settable in the
1684
261
# 		environment.
1685
262
# Chris Monson (2007-02-23):
1686
263
# 	* Bumped version to 2.1.2
1687
264
# 	* Added the ability to generate .tex files from .rst files
1688
265
# Chris Monson (2006-10-17):
1689
266
# 	* Bumped version to 2.1.1
1690
267
# 	* Fixed includes from subdirectories (sed-to-sed slash escape problem)
1691
268
# Chris Monson (2006-10-05):
1692
269
# 	* Bumped version to 2.1.0 (pretty serious new feature added)
1693
270
# 	* New feature: bib files can now be anywhere on the BIBINPUTS path
1694
271
# 	* New programs: kpsewhich (with tetex) and xargs (BSD)
1695
272
# Chris Monson (2006-09-28):
1696
273
# 	* Bumped version to 2.0.9
1697
274
# 	* Added ability to parse more than one bibliography
1698
275
# Chris Monson (2006-06-01):
1699
276
# 	* Bumped version to 2.0.8
1700
277
# 	* Added .vrb to the list of cleaned files
1701
278
# Chris Monson (2006-04-26):
1702
279
# 	* Bumped version to 2.0.7
1703
280
# 	* Fixed so that clean-nographics does not remove .gpi.d files
1704
281
# 	* Removed jpg -> eps hack (not working properly -- just pre-convert)
1705
282
# 	* Fixed so that postscript grayscale can be done with BSD sed
1706
283
# Chris Monson (2006-04-25):
1707
284
# 	* Bumped version to 2.0.6
1708
285
# 	* Fixed so that changed toc, lot, lof, or out causes a rebuild
1709
286
# Chris Monson (2006-04-17):
1710
287
# 	* Bumped version to 2.0.5
1711
288
# 	* Added jpg -> eps conversion target
1712
289
# Chris Monson (2006-04-12):
1713
290
# 	* Bumped version to 2.0.4
1714
291
# 	* Fixed BSD sed invocation to not use \| as a branch delimiter
1715
292
# 	* Added a comment section on what is and is not allowed in BSD sed
1716
293
# 	* Made paper size handling more robust while I was at it
1717
294
# 	* Fixed postscript RGB grayscale to use a weighted average
1718
295
# 	* Fixed postscript HSB grayscale to convert to RGB first
1719
296
# 	* Fixed a problem with rebuilding .bbl files
1720
297
# Chris Monson (2006-04-11):
1721
298
# 	* Bumped version to 2.0.3
1722
299
# 	* Fixed some BSD sed problems: can't use \n in substitutions
1723
300
# Chris Monson (2006-04-10):
1724
301
# 	* Bumped version to 2.0.2
1725
302
# 	* Once again removed ability to create .tex files from scripts
1726
303
# 	* \includeonly works again
1727
304
# Chris Monson (2006-04-09):
1728
305
# 	* Bumped version to 2.0.1
1729
306
# 	* Fixed grayscale postscript handling to be more robust
1730
307
# 	* Added ability to generate ._gray_. files from eps and eps.gz
1731
308
# 	* Added ability to clean ._gray_.eps files created from .eps files
1732
309
# Chris Monson (2006-04-07):
1733
310
# 	* Bumped version to 2.0.0
1734
311
# 	* Removed clunky ability to create included .tex files from scripts
1735
312
# 	* Added note in the help about included tex scripting not working
1736
313
# 	* Fixed the .eps generation to delete %.gpihead.make when finished
1737
314
# 	* Abandoned designs to use shell variables to create sed scripts
1738
315
# 	* Abandoned __default__.tex.sh idea: it causes recursion with %: .
1739
316
# 	* Removed web page to-do.  All items are now complete.
1740
317
# 	* Added better grayscale conversion for dot figures (direct ps fixup).
1741
318
# 	* Include files can now be scripted (at the expense of \includeonly).
1742
319
# 	* Updated dependency graph to contain better node names.
1743
320
# Chris Monson (2006-04-06):
1744
321
# 	* Bumped version to 2.0b3
1745
322
# 	* Top level includes now fail if there is no rule to build them
1746
323
# 	* A helpful message is printed when they do fail
1747
324
# 	* Grayscale has been changed to be ._gray_, other phonies use _ now, too
1748
325
# 	* Grayscale handling has been completed
1749
326
# 	* Changed _include_stems target to _includes target.
1750
327
# 	* Fixed _includes target to be useful by itself.
1751
328
# 	* Removed the ability to specify clean and build targets at once
1752
329
# 	* Verified that epsfig works fine with current code
1753
330
# 	* Fixed included scripts so that they are added to the dep files
1754
331
# 	* Fixed so that graphics includes don't happen if they aren't for gpi
1755
332
# 	* Fixed dot output to allow grayscale.
1756
333
# Chris Monson (2006-04-05):
1757
334
#	* Bumped version to 2.0b2
1758
335
#	* Removed automatic -gray output.  It needs fixing in a bad way.
1759
336
#	* Revamped dependency creation completely.
1760
337
#	* Fixed conditional inclusion to actually work (test.nobuild.d, test.d).
1761
338
#	* Fixed clean target to remove log targets
1762
339
#	* Added the 'monochrome' word for gray gpi output
1763
340
#	* Added a _check_gpi_files target that checks for common problems
1764
341
#	* Changed the _version target into the version target (no _)
1765
342
#	* Added better handling of grayscale files.  Use the .gray.pdf target.
1766
343
#	* Fixed testing for rebuilds
1767
344
# Chris Monson (2006-04-04):
1768
345
#	* Bumped version to 2.0b1
1769
346
#	* Changed colorization of output
1770
347
#	* Made .auxbbl and .auxtex .make files secondary targets
1771
348
#	* Shortened and simplified the final latex invocation loop
1772
349
#	* Added version-specific output ($$i vs. $$$$i) in latex loop
1773
350
#	* Added a build message for the first .dvi run (Building .dvi (0))
1774
351
#	* Removed some build messages that most people don't care about.
1775
352
#	* Simplified procedure for user-set colors -- simple text specification
1776
353
#	* Fixed diff output to...not output.
1777
354
#	* Fixed rerun bug -- detect not only when preceded with LaTeX Warning
1778
355
#	* Sped up gpi plotting
1779
356
#	* Added error handling and colorized output for gpi failure
1780
357
#	* Documented color changing stuff.
1781
358
#	* Now sort the flattened aux file to avoid false recompilation needs
1782
359
#	* Added clean-nographics target
1783
360
#	* Don't remove self.dvi file if self.aux is missing in the log
1784
361
#	* Clarified some code.  Did some very minor adjusting.
1785
362
# Chris Monson (2006-04-03):
1786
363
#	* Bumped version to 2.0a7
1787
364
#	* Added .dvi and .ps files as secondary files.
1788
365
#	* Fixed handling of multiple run detection when includeonly is in use.
1789
366
#	* Added code to flatten .aux files.
1790
367
#	* Added more files as .SECONDARY prerequisites to avoid recompilation.
1791
368
#	* Fixed the inputs generation to be much simpler and to use pipes.
1792
369
#	* Added the dependency graph directly into the makefile.
1793
370
#	* Changed flatten-aux to remove \@writefile \relax \newlabel, etc.
1794
371
#	* Undid pipe changes with sed usage (BSD sed doesn't know -f-).
1795
372
#	* Added a _check_programs target that tells you what your system has.
1796
373
#	* Fixed an error in colorization that made unnecessary errors appear
1797
374
#	* Added view targets.
1798
375
#	* Updated help text.
1799
376
#	* Augmented cookies so that .aux can trigger .bbl and .dvi rebuilds
1800
377
#	* Added more informative error handling for dvips and ps2pdf
1801
378
# Chris Monson (2006-04-02):
1802
379
#	* Bumped version to 2.0a6
1803
380
#	* Added indirection to .bbl dependencies to avoid rebuilding .bbl files
1804
381
#	* Streamlined the diff invocation to eliminate an existence test
1805
382
#	* Removed special shell quote escape variables
1806
383
#	* Moved includes to a more prominent location
1807
384
#	* Fixed .inputs.make to not contain .aux files
1808
385
#	* Fixed embedding to use a file instead of always grepping.
1809
386
#	* Added *.make.temp to the list of cleanable files
1810
387
#	* Fixed Ruby.  It should now be supported properly.
1811
388
#	* Now differentiate between all, default, and buildable files.
1812
389
#	* Fixed to bail out on serious errors.
1813
390
#	* Revised the handling of includable files.  Still working on it.
1814
391
# Chris Monson (2006-03-31):
1815
392
#	* Bumped version to 2.0a5
1816
393
#	* Fixed a bug with LaTeX error detection (there can be spaces)
1817
394
#	* Added .bbl support, simplifying everything and making it more correct
1818
395
#	* Refactored some tests that muddy the code
1819
396
#	* Did a little cleanup of some shell loops that can safely be make loops
1820
397
#	* Added support for graphviz .dot files
1821
398
#	* Made _all_programs output easier to read
1822
399
#	* Added the ruby support that has long been advertised
1823
400
#	* Font embedding was screwed up for PostScript -- now implicit
1824
401
#	* Changed the generation of -gray.gpi files to a single command
1825
402
#	* Changed any make-generated file that is not included from .d to .make
1826
403
# Chris Monson (2006-03-30):
1827
404
#	* Bumped version to 2.0a4
1828
405
#	* Fixed a bug with very long graphics file names
1829
406
#	* Added a todo entry for epsfig support
1830
407
#	* Fixed a bug paper size bug: sometimes more than one entry appears
1831
408
#	* Fixed DVI build echoing to display the number instead of process ID
1832
409
#	* DVI files are now removed on first invocation if ANY file is missing
1833
410
#	* Added a simple grayscale approach: if a file ends with -gray.gpi, it
1834
411
#		is created from the corresponding .gpi file with a special
1835
412
#		comment ##GRAY in its header, which causes coloring to be
1836
413
#		turned off.
1837
414
#	* Fixed a bug in the handling of .tex.sh files.  For some reason I had
1838
415
#		neglected to define file stems for scripted output.
1839
416
#	* Removed a trailing ; from the %.graphics dependencies
1840
417
#	* Added dvips embedding (I think it works, anyway)
1841
418
# Chris Monson (2006-03-29):
1842
419
#	* Bumped version to 2.0a3
1843
420
#	* Fixed error in make 3.79 with MAKEFILE_LIST usage
1844
421
#	* Added the presumed filename to the _version output
1845
422
#	* Added a vim macro for converting sed scripts to make commands
1846
423
#	* Added gpi dependency support (plotting external files and loading gpi)
1847
424
#	* Allow .gpi files to be ignored if called .include.gpi or .nobuild.gpi
1848
425
#	* Fixed sed invocations where \+ was used.  BSD sed uses \{1,\}.
1849
426
# Chris Monson (2006-03-28):
1850
427
#	* Bumped version to 2.0a2
1851
428
#	* Added SHELL_DEBUG and VERBOSE options
1852
429
#	* Changed the default shell back to /bin/sh (unset, in other words)
1853
430
#	* Moved .PHONY declarations closer to their targets
1854
431
#	* Moved help text into its own define block to obtain better formatting
1855
432
#	* Removed need for double-entry when adding a new program invocation
1856
433
#	* Moved .SECONDARY declaration closer to its relevant occurrence
1857
434
#	* Commented things more heavily
1858
435
#	* Added help text about setting terminal and output in gnuplot
1859
436
#	* Created more fine-grained clean targets
1860
437
#	* Added a %.graphics target that generates all of %'s graphics
1861
438
#	* Killed backward-compatible graphics generation (e.g., eps.gpi=gpi.eps)
1862
439
#	* For now, we're just GPL 2, not 3.  Maybe it will change later
1863
440
#	* Made the version and svninfo into variables
1864
441
# Chris Monson (2006-03-27):
1865
442
#	* Bumped version to 2.0a1
1866
443
#	* Huge, sweeping changes -- automatic dependencies
1867
444
1868
445
# IMPORTANT!
1869
446
#
1870
447
# When adding to the following list, do not introduce any blank lines.  The
1871
448
# list is extracted for documentation using sed and is terminated by a blank
1872
449
# line.
1873
450
#
1874
451
# EXTERNAL PROGRAMS:
1875
452
# = ESSENTIAL PROGRAMS =
1876
453
# == Basic Shell Utilities ==
1877
454
CAT		?= cat
1878
455
CP		?= cp -f
1879
456
DIFF		?= diff
1880
457
ECHO		?= echo
1881
458
EGREP		?= egrep
1882
459
ENV		?= env
1883
460
MV		?= mv -f
1884
461
SED		?= sed
1885
462
SORT		?= sort
1886
463
TOUCH		?= touch
1887
464
UNIQ		?= uniq
1888
465
WHICH		?= which
1889
466
XARGS		?= xargs
1890
467
# == LaTeX (tetex-provided) ==
1891
468
BIBTEX		?= bibtex
1892
469
DVIPS		?= dvips
1893
470
LATEX		?= latex
1894
471
MAKEINDEX	?= makeindex
1895
472
KPSEWHICH	?= kpsewhich
1896
473
GS		?= gs
1897
474
# = OPTIONAL PROGRAMS =
1898
475
# == Makefile Color Output ==
1899
476
TPUT		?= tput
1900
477
# == TeX Generation ==
1901
478
RST2LATEX	?= rst2latex.py
1902
479
# == EPS Generation ==
1903
480
CONVERT		?= convert	# ImageMagick
1904
481
DOT		?= dot		# GraphViz
1905
482
DOT2TEX		?= dot2tex	# dot2tex - add options (not -o) as needed
1906
483
FIG2DEV		?= fig2dev	# XFig
1907
484
GNUPLOT		?= gnuplot	# GNUplot
1908
485
INKSCAPE	?= inkscape	# Inkscape (svg support)
1909
486
XMGRACE		?= xmgrace	# XMgrace
1910
487
PNGTOPNM	?= pngtopnm	# From NetPBM - step 1 for png -> eps
1911
488
PPMTOPGM	?= ppmtopgm	# From NetPBM - (gray) step 2 for png -> eps
1912
489
PNMTOPS		?= pnmtops	# From NetPBM - step 3 for png -> eps
1913
490
GUNZIP		?= gunzip	# GZipped EPS
1914
491
# == Beamer Enlarged Output ==
1915
492
PSNUP		?= psnup
1916
493
# == Viewing Stuff ==
1917
494
VIEW_POSTSCRIPT	?= gv
1918
495
VIEW_PDF	?= evince
1919
496
VIEW_GRAPHICS	?= display
1920
497
1921
498
# Command options for embedding fonts and postscript->pdf conversion
1922
499
PS_EMBED_OPTIONS	?= -dPDFSETTINGS=/printer -dEmbedAllFonts=true -dSubsetFonts=true -dMaxSubsetPct=100
1923
500
PS_COMPATIBILITY	?= 1.4
1924
501
1925
502
# This ensures that even when echo is a shell builtin, we still use the binary
1926
503
# (the builtin doesn't always understand -n)
1927
504
FIXED_ECHO	:= $(if $(findstring -n,$(shell $(ECHO) -n)),$(shell which echo),$(ECHO))
1928
505
ECHO		:= $(if $(FIXED_ECHO),$(FIXED_ECHO),$(ECHO))
1929
506
1930
507
# Directory into which we place "binaries" if it exists.
1931
508
# Note that this can be changed on the commandline or in Makefile.ini:
1932
509
#
1933
510
# Command line:
1934
511
#   make BINARY_TARGET_DIR=$HOME/pdfs myfile.pdf
1935
512
#
1936
513
# Also, you can specify a relative directory (relative to the Makefile):
1937
514
#   make BINARY_TARGET_DIR=pdfs myfile.pdf
1938
515
#
1939
516
# Or, you can use Makefile.ini:
1940
517
#
1941
518
#   BINARY_TARGET_DIR := $(HOME)/bin_out
1942
519
#
1943
520
BINARY_TARGET_DIR	?= _out_
1944
521
1945
522
# SH NOTES
1946
523
#
1947
524
# On some systems, /bin/sh, which is the default shell, is not linked to
1948
525
# /bin/bash.  While bash is supposed to be sh-compatible when invoked as sh, it
1949
526
# just isn't.  This section details some of the things you have to stay away
1950
527
# from to remain sh-compatible.
1951
528
#
1952
529
#	* File pattern expansion does not work for {}
1953
530
#	* [ "$x" = "$y" ] has to be [ x"$x" x"$y" ]
1954
531
#	* &> for stderr redirection doesn't work, use 2>&1 instead
1955
532
#
1956
533
# BSD SED NOTES
1957
534
#
1958
535
# BSD SED is not very nice compared to GNU sed, but it is the most
1959
536
# commonly-invoked sed on Macs (being based on BSD), so we have to cater to
1960
537
# it or require people to install GNU sed.  It seems like the GNU
1961
538
# requirement isn't too bad since this makefile is really a GNU makefile,
1962
539
# but apparently GNU sed is much less common than GNU make in general, so
1963
540
# I'm supporting it here.
1964
541
#
1965
542
# Sad experience has taught me the following about BSD sed:
1966
543
#
1967
544
# 	* \+ is not understood to mean \{1,\}
1968
545
# 	* \| is meaningless (does not branch)
1969
546
# 	* \n cannot be used as a substitution character
1970
547
# 	* ? does not mean \{0,1\}, but is literal
1971
548
# 	* a\ works, but only reliably for a single line if subsequent lines
1972
549
# 		have forward slashes in them (as is the case in postscript)
1973
550
#
1974
551
# For more info (on the Mac) you can consult
1975
552
#
1976
553
# man -M /usr/share/man re_format
1977
554
#
1978
555
# And look for the word "Obsolete" near the bottom.
1979
556
1980
557
#
1981
558
# EXTERNAL PROGRAM DOCUMENTATION SCRIPT
1982
559
#
1983
560
1984
561
# $(call output-all-programs,[<output file>])
1985
562
define output-all-programs
1986
563
	[ -f '$(this_file)' ] && \
1987
564
	$(SED) \
1988
565
		-e '/^[[:space:]]*#[[:space:]]*EXTERNAL PROGRAMS:/,/^$$/!d' \
1989
566
		-e '/EXTERNAL PROGRAMS/d' \
1990
567
		-e '/^$$/d' \
1991
568
		-e '/^[[:space:]]*#/i\ '\
1992
569
		-e 's/^[[:space:]]*#[[:space:]][^=]*//' \
1993
570
		$(this_file) $(if $1,> '$1',) || \
1994
571
	$(ECHO) "Cannot determine the name of this makefile."
1995
572
endef
1996
573
1997
574
# If they misspell gray, it should still work.
1998
575
GRAY	?= $(call get-default,$(GREY),)
1999
576
2000
577
#
2001
578
# Utility Functions and Definitions
2002
579
#
2003
580
2004
581
# While not exactly a make function, this vim macro is useful.  It takes a
2005
582
# verbatim sed script and converts each line to something suitable in a command
2006
583
# context.  Just paste the script's contents into the editor, yank this into a
2007
584
# register (starting at '0') and run the macro once for each line of the
2008
585
# original script:
2009
586
#
2010
587
# 0i	-e :s/\$/$$/eg
2011
0
:s/'/'"'"'/eg
588
:s/'/'"'"'/eg
2012
1
^Ela'A' \:noh
589
^Ela'A' \:noh
2013
2
j
590
j
2014
591
2015
592
# don't call this directly - it is here to avoid calling wildcard more than
2016
593
# once in remove-files.
2017
594
remove-files-helper	= $(if $1,$(RM) $1,:)
2018
595
2019
596
# $(call remove-files,file1 file2)
2020
597
remove-files		= $(call remove-files-helper,$(wildcard $1))
2021
598
2022
599
# Removes all cleanable files in the given list
2023
600
# $(call clean-files,file1 file2 file3 ...)
2024
601
# Works exactly like remove-files, but filters out files in $(neverclean)
2025
602
clean-files		= \
2026
603
	$(call remove-files-helper,$(call cleanable-files,$(wildcard $1)))
2027
604
2028
605
# Outputs all generated files to STDOUT, along with some others that are
2029
606
# created by these (e.g., .idx files end up producing .ilg and .ind files).
2030
607
# Discovered by reading *.fls OUTPUT lines and producing corresponding .ind
2031
608
# filenames as needed.
2032
609
#
2033
610
# $(call get-generated-names,<source recorder file (*.fls)>)
2034
611
define get-generated-names
2035
612
[ -f '$1' ] && \
2036
613
$(SED) \
2037
614
	-e '/^OUTPUT /{' \
2038
615
	-e '  s///' \
2039
616
	-e '  p' \
2040
617
	-e '  s/\.idx/\.ind/p' \
2041
618
	-e '  s/\.ind/\.ilg/p' \
2042
619
	-e '}' \
2043
620
	-e 'd' \
2044
621
	'$1' \
2045
622
| $(SORT) | $(UNIQ)
2046
623
endef
2047
624
2048
625
# This removes files without checking whether they are there or not.  This
2049
626
# sometimes has to be used when the file is created by a series of shell
2050
627
# commands, but there ends up being a race condition: make doesn't know about
2051
628
# the file generation as quickly as the system does, so $(wildcard ...) doesn't
2052
629
# work right.  Blech.
2053
630
# $(call remove-temporary-files,filenames)
2054
631
remove-temporary-files	= $(if $1,$(RM) $1,:)
2055
632
2056
633
# Create an identifier from a file name
2057
634
# $(call cleanse-filename,filename)
2058
635
cleanse-filename	= $(subst .,_,$(subst /,__,$1))
2059
636
2060
637
# Escape dots
2061
638
# $(call escape-dots,str)
2062
639
escape-dots		= $(subst .,\\.,$1)
2063
640
2064
641
# Test that a file exists
2065
642
# $(call test-exists,file)
2066
643
test-exists		= [ -e '$1' ]
2067
644
2068
645
# Copy file1 to file2 only if file2 doesn't exist or they are different
2069
646
# $(call copy-if-different,sfile,dfile)
2070
647
copy-if-different	= $(call test-different,$1,$2) && $(CP) '$1' '$2'
2071
648
copy-if-exists		= $(call test-exists,$1) && $(CP) '$1' '$2'
2072
649
move-if-different	= $(call test-different,$1,$2) && $(MV) '$1' '$2'
2073
650
replace-if-different-and-remove	= \
2074
651
	$(call test-different,$1,$2) \
2075
652
	&& $(MV) '$1' '$2' \
2076
653
	|| $(call remove-files,'$1')
2077
654
2078
655
# Note that $(DIFF) returns success when the files are the SAME....
2079
656
# $(call test-different,sfile,dfile)
2080
657
test-different		= ! $(DIFF) -q '$1' '$2' >/dev/null 2>&1
2081
658
test-exists-and-different	= \
2082
659
	$(call test-exists,$2) && $(call test-different,$1,$2)
2083
660
2084
661
# Return value 1, or value 2 if value 1 is empty
2085
662
# $(call get-default,<possibly empty arg>,<default value if empty>)
2086
663
get-default	= $(if $1,$1,$2)
2087
664
2088
665
# Copy a file and log what's going on
2089
666
# $(call copy-with-logging,<source>,<target>)
2090
667
define copy-with-logging
2091
668
if [ -d '$2/' ]; then \
2092
669
	if $(CP) '$1' '$2/'; then \
2093
670
		$(ECHO) "$(C_INFO)Copied '$1' to '$2/'$(C_RESET)"; \
2094
671
	else \
2095
672
		$(ECHO) "$(C_ERROR)Failed to copy '$1' to '$2/'$(C_RESET)"; \
2096
673
	fi; \
2097
674
fi
2098
675
endef
2099
676
2100
677
# Gives a reassuring message about the failure to find include files
2101
678
# $(call include-message,<list of include files>)
2102
679
define include-message
2103
680
$(strip \
2104
681
$(if $(filter-out $(wildcard $1),$1),\
2105
682
	$(shell $(ECHO) \
2106
683
	"$(C_INFO)NOTE: You may ignore warnings about the"\
2107
684
	"following files:" >&2;\
2108
685
	$(ECHO) >&2; \
2109
686
	$(foreach s,$(filter-out $(wildcard $1),$1),$(ECHO) '     $s' >&2;)\
2110
687
	$(ECHO) "$(C_RESET)" >&2)
2111
688
))
2112
689
endef
2113
690
# Characters that are hard to specify in certain places
2114
691
space		:= $(empty) $(empty)
2115
692
colon		:= \:
2116
693
comma		:= ,
2117
694
2118
695
# Useful shell definitions
2119
696
sh_true		:= :
2120
697
sh_false	:= ! :
2121
698
2122
699
# Clear out the standard interfering make suffixes
2123
700
.SUFFIXES:
2124
701
2125
702
# Turn off forceful rm (RM is usually mapped to rm -f)
2126
703
ifdef SAFE_RM
2127
704
RM	:= rm
2128
705
endif
2129
706
2130
707
# Turn command echoing back on with VERBOSE=1
2131
708
ifndef VERBOSE
2132
709
QUIET	:= @
2133
710
endif
2134
711
2135
712
# Turn on shell debugging with SHELL_DEBUG=1
2136
713
# (EVERYTHING is echoed, even $(shell ...) invocations)
2137
714
ifdef SHELL_DEBUG
2138
715
SHELL	+= -x
2139
716
endif
2140
717
2141
718
# Get the name of this makefile (always right in 3.80, often right in 3.79)
2142
719
# This is only really used for documentation, so it isn't too serious.
2143
720
ifdef MAKEFILE_LIST
2144
721
this_file	:= $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
2145
722
else
2146
723
this_file	:= $(wildcard GNUmakefile makefile Makefile)
2147
724
endif
2148
725
2149
726
# Terminal color definitions
2150
727
2151
728
ifdef NO_COLOR
2152
729
tput		=
2153
730
else
2154
731
tput		= $(shell $(TPUT) $1)
2155
732
endif
2156
733
2157
734
black	:= $(call tput,setaf 0)
2158
735
red	:= $(call tput,setaf 1)
2159
736
green	:= $(call tput,setaf 2)
2160
737
yellow	:= $(call tput,setaf 3)
2161
738
blue	:= $(call tput,setaf 4)
2162
739
magenta	:= $(call tput,setaf 5)
2163
740
cyan	:= $(call tput,setaf 6)
2164
741
white	:= $(call tput,setaf 7)
2165
742
bold	:= $(call tput,bold)
2166
743
uline	:= $(call tput,smul)
2167
744
reset	:= $(call tput,sgr0)
2168
745
2169
746
#
2170
747
# User-settable definitions
2171
748
#
2172
749
LATEX_COLOR_WARNING	?= magenta
2173
750
LATEX_COLOR_ERROR	?= red
2174
751
LATEX_COLOR_INFO	?= green
2175
752
LATEX_COLOR_UNDERFULL	?= magenta
2176
753
LATEX_COLOR_OVERFULL	?= red bold
2177
754
LATEX_COLOR_PAGES	?= bold
2178
755
LATEX_COLOR_BUILD	?= blue
2179
756
LATEX_COLOR_GRAPHIC	?= yellow
2180
757
LATEX_COLOR_DEP		?= green
2181
758
LATEX_COLOR_SUCCESS	?= green bold
2182
759
LATEX_COLOR_FAILURE	?= red bold
2183
760
2184
761
# Gets the real color from a simple textual definition like those above
2185
762
# $(call get-color,ALL_CAPS_COLOR_NAME)
2186
763
# e.g., $(call get-color,WARNING)
2187
764
get-color	= $(subst $(space),,$(foreach c,$(LATEX_COLOR_$1),$($c)))
2188
765
2189
766
#
2190
767
# STANDARD COLORS
2191
768
#
2192
769
C_WARNING	:= $(call get-color,WARNING)
2193
770
C_ERROR		:= $(call get-color,ERROR)
2194
771
C_INFO		:= $(call get-color,INFO)
2195
772
C_UNDERFULL	:= $(call get-color,UNDERFULL)
2196
773
C_OVERFULL	:= $(call get-color,OVERFULL)
2197
774
C_PAGES		:= $(call get-color,PAGES)
2198
775
C_BUILD		:= $(call get-color,BUILD)
2199
776
C_GRAPHIC	:= $(call get-color,GRAPHIC)
2200
777
C_DEP		:= $(call get-color,DEP)
2201
778
C_SUCCESS	:= $(call get-color,SUCCESS)
2202
779
C_FAILURE	:= $(call get-color,FAILURE)
2203
780
C_RESET		:= $(reset)
2204
781
2205
782
#
2206
783
# PRE-BUILD TESTS
2207
784
#
2208
785
2209
786
# Check that clean targets are not combined with other targets (weird things
2210
787
# happen, and it's not easy to fix them)
2211
788
hascleangoals	:= $(if $(sort $(filter clean clean-%,$(MAKECMDGOALS))),1)
2212
789
hasbuildgoals	:= $(if $(sort $(filter-out clean clean-%,$(MAKECMDGOALS))),1)
2213
790
ifneq "$(hasbuildgoals)" ""
2214
791
ifneq "$(hascleangoals)" ""
2215
792
$(error $(C_ERROR)Clean and build targets specified together$(C_RESET)))
2216
793
endif
2217
794
endif
2218
795
2219
796
#
2220
797
# VARIABLE DECLARATIONS
2221
798
#
2222
799
2223
800
# Names of sed scripts that morph gnuplot files -- only the first found is used
2224
801
GNUPLOT_SED	:= global-gpi.sed gnuplot.sed
2225
802
GNUPLOT_GLOBAL	:= global._include_.gpi gnuplot.global
2226
803
2227
804
# Files of interest
2228
805
all_files.tex		?= $(wildcard *.tex)
2229
806
all_files.tex.sh	?= $(wildcard *.tex.sh)
2230
807
all_files.rst		?= $(wildcard *.rst)
2231
808
all_files.fig		?= $(wildcard *.fig)
2232
809
all_files.gpi		?= $(wildcard *.gpi)
2233
810
all_files.dot		?= $(wildcard *.dot)
2234
811
all_files.xvg		?= $(wildcard *.xvg)
2235
812
all_files.svg		?= $(wildcard *.svg)
2236
813
all_files.png		?= $(wildcard *.png)
2237
814
all_files.jpg		?= $(wildcard *.jpg)
2238
815
all_files.eps.gz	?= $(wildcard *.eps.gz)
2239
816
all_files.eps		?= $(wildcard *.eps)
2240
817
2241
818
# Utility function for obtaining all files not specified in $(neverclean)
2242
819
# $(call cleanable-files,file1 file2 file3 ...)
2243
820
# Returns the list of files that is not in $(wildcard $(neverclean))
2244
821
cleanable-files = $(filter-out $(wildcard $(neverclean)), $1)
2245
822
2246
823
# Utility function for getting all .$1 files that are to be ignored
2247
824
#  * files listed in $(includes.$1)
2248
825
#  * files not listed in $(onlysources.$1) if it is defined
2249
826
ignore_files = \
2250
827
  $(includes.$1) \
2251
828
  $(if $(onlysources.$1),$(filter-out $(onlysources.$1), $(all_files.$1)))
2252
829
2253
830
# Patterns to never be allowed as source targets
2254
831
ignore_patterns	:= %._include_
2255
832
2256
833
# Patterns allowed as source targets but not included in 'all' builds
2257
834
nodefault_patterns := %._nobuild_ $(ignore_patterns)
2258
835
2259
836
# Utility function for getting targets suitable building
2260
837
# $(call filter-buildable,suffix)
2261
838
filter-buildable	= \
2262
839
	$(filter-out $(call ignore_files,$1) \
2263
840
		$(addsuffix .$1,$(ignore_patterns)),$(all_files.$1))
2264
841
2265
842
# Utility function for getting targets suitable for 'all' builds
2266
843
# $(call filter-default,suffix)
2267
844
filter-default		= \
2268
845
	$(filter-out $(call ignore_files,$1) \
2269
846
		$(addsuffix .$1,$(nodefault_patterns)),$(all_files.$1))
2270
847
2271
848
# Top level sources that can be built even when they are not by default
2272
849
files.tex	:= $(filter-out %._gray_.tex,$(call filter-buildable,tex))
2273
850
files.tex.sh	:= $(call filter-buildable,tex.sh)
2274
851
files.rst	:= $(call filter-buildable,rst)
2275
852
files.gpi	:= $(call filter-buildable,gpi)
2276
853
files.dot	:= $(call filter-buildable,dot)
2277
854
files.fig	:= $(call filter-buildable,fig)
2278
855
files.xvg	:= $(call filter-buildable,xvg)
2279
856
files.svg	:= $(call filter-buildable,svg)
2280
857
files.png	:= $(call filter-buildable,png)
2281
858
files.jpg	:= $(call filter-buildable,jpg)
2282
859
files.eps.gz	:= $(call filter-buildable,eps.gz)
2283
860
2284
861
# Make all pstex targets secondary.  The pstex_t target requires the pstex
2285
862
# target, and nothing else really depends on it, so it often gets deleted.
2286
863
# This avoids that by allowing *all* fig files to be pstex targets, which is
2287
864
# perfectly valid and causes no problems even if they're going to become eps
2288
865
# files in the end.
2289
866
.SECONDARY:	$(patsubst %.fig,%.pstex,$(files.fig))
2290
867
.SECONDARY:	$(patsubst %.fig,%._gray_.pstex,$(files.fig))
2291
868
2292
869
# Top level sources that are built by default targets
2293
870
default_files.tex	:= $(filter-out %._gray_.tex,$(call filter-default,tex))
2294
871
default_files.tex.sh	:= $(call filter-default,tex.sh)
2295
872
default_files.rst	:= $(call filter-default,rst)
2296
873
default_files.gpi	:= $(call filter-default,gpi)
2297
874
default_files.dot	:= $(call filter-default,dot)
2298
875
default_files.fig	:= $(call filter-default,fig)
2299
876
default_files.xvg	:= $(call filter-default,xvg)
2300
877
default_files.svg	:= $(call filter-default,svg)
2301
878
default_files.png	:= $(call filter-default,png)
2302
879
default_files.jpg	:= $(call filter-default,jpg)
2303
880
default_files.eps.gz	:= $(call filter-default,eps.gz)
2304
881
2305
882
# Utility function for creating larger lists of files
2306
883
# $(call concat-files,suffixes,[prefix])
2307
884
concat-files	= $(foreach s,$1,$($(if $2,$2_,)files.$s))
2308
885
2309
886
# Useful file groupings
2310
887
all_files_source	:= $(call concat-files,tex,all)
2311
888
all_files_scripts	:= $(call concat-files,tex.sh rst,all)
2312
889
all_files_graphics	:= $(call concat-files,fig gpi eps.gz xvg svg png jpg dot,all)
2313
890
2314
891
default_files_source	:= $(call concat-files,tex,default)
2315
892
default_files_scripts	:= $(call concat-files,tex.sh rst,default)
2316
893
default_files_graphics	:= $(call concat-files,fig gpi eps.gz xvg svg png jpg dot,default)
2317
894
2318
895
files_source	:= $(call concat-files,tex)
2319
896
files_scripts	:= $(call concat-files,tex.sh rst)
2320
897
files_graphics	:= $(call concat-files,fig gpi eps.gz xvg svg png jpg dot)
2321
898
2322
899
# Utility function for obtaining stems
2323
900
# $(call get-stems,suffix,[prefix])
2324
901
get-stems	= $(sort $($(if $2,$2_,)files.$1:%.$1=%))
2325
902
2326
903
# List of all stems (including ._include_ and ._nobuild_ file stems)
2327
904
all_stems.tex		:= $(call get-stems,tex,all)
2328
905
all_stems.tex.sh	:= $(call get-stems,tex.sh,all)
2329
906
all_stems.rst		:= $(call get-stems,rst,all)
2330
907
all_stems.fig		:= $(call get-stems,fig,all)
2331
908
all_stems.gpi		:= $(call get-stems,gpi,all)
2332
909
all_stems.dot		:= $(call get-stems,dot,all)
2333
910
all_stems.xvg		:= $(call get-stems,xvg,all)
2334
911
all_stems.svg		:= $(call get-stems,svg,all)
2335
912
all_stems.png		:= $(call get-stems,png,all)
2336
913
all_stems.jpg		:= $(call get-stems,jpg,all)
2337
914
all_stems.eps.gz	:= $(call get-stems,eps.gz,all)
2338
915
all_stems.eps		:= $(call get-stems,eps,all)
2339
916
2340
917
# List of all default stems (all default PDF targets):
2341
918
default_stems.tex		:= $(call get-stems,tex,default)
2342
919
default_stems.tex.sh		:= $(call get-stems,tex.sh,default)
2343
920
default_stems.rst		:= $(call get-stems,rst,default)
2344
921
default_stems.fig		:= $(call get-stems,fig,default)
2345
922
default_stems.gpi		:= $(call get-stems,gpi,default)
2346
923
default_stems.dot		:= $(call get-stems,dot,default)
2347
924
default_stems.xvg		:= $(call get-stems,xvg,default)
2348
925
default_stems.svg		:= $(call get-stems,svg,default)
2349
926
default_stems.png		:= $(call get-stems,png,default)
2350
927
default_stems.jpg		:= $(call get-stems,jpg,default)
2351
928
default_stems.eps.gz		:= $(call get-stems,eps.gz,default)
2352
929
2353
930
# List of all stems (all possible bare PDF targets created here):
2354
931
stems.tex		:= $(call get-stems,tex)
2355
932
stems.tex.sh		:= $(call get-stems,tex.sh)
2356
933
stems.rst		:= $(call get-stems,rst)
2357
934
stems.fig		:= $(call get-stems,fig)
2358
935
stems.gpi		:= $(call get-stems,gpi)
2359
936
stems.dot		:= $(call get-stems,dot)
2360
937
stems.xvg		:= $(call get-stems,xvg)
2361
938
stems.svg		:= $(call get-stems,svg)
2362
939
stems.png		:= $(call get-stems,png)
2363
940
stems.jpg		:= $(call get-stems,jpg)
2364
941
stems.eps.gz		:= $(call get-stems,eps.gz)
2365
942
2366
943
# Utility function for creating larger lists of stems
2367
944
# $(call concat-stems,suffixes,[prefix])
2368
945
concat-stems	= $(sort $(foreach s,$1,$($(if $2,$2_,)stems.$s)))
2369
946
2370
947
all_stems_source	:= $(call concat-stems,tex,all)
2371
948
all_stems_script	:= $(call concat-stems,tex.sh rst,all)
2372
949
all_stems_graphic	:= $(call concat-stems,fig gpi eps.gz xvg svg png jpg dot,all)
2373
950
all_stems_gray_graphic	:= $(addsuffix ._gray_,\
2374
951
	$(all_stems_graphic) $(all_stems.eps) \
2375
952
	)
2376
953
all_stems_gg		:= $(sort \
2377
954
	$(all_stems_graphic) $(all_stems_gray_graphic))
2378
955
all_stems_ss		:= $(sort $(all_stems_source) $(all_stems_script))
2379
956
all_stems_gray		:= $(addsuffix ._gray_,$(all_stems_ss))
2380
957
all_stems_sg		:= $(sort $(all_stems_script) $(all_stems_gray))
2381
958
all_stems_ssg		:= $(sort $(all_stems_ss) $(all_stems_gray))
2382
959
2383
960
default_stems_source	:= $(call concat-stems,tex,default)
2384
961
default_stems_script	:= $(call concat-stems,tex.sh rst,default)
2385
962
default_stems_graphic	:= $(call concat-stems,fig gpi eps.gz xvg svg png jpg dot,default)
2386
963
default_stems_gray_graphic	:= $(addsuffix ._gray_,$(default_stems_graphic))
2387
964
default_stems_gg	:= $(sort \
2388
965
	$(default_stems_graphic) $(default_stems_gray_graphic))
2389
966
default_stems_ss	:= $(sort \
2390
967
	$(default_stems_source) $(default_stems_script))
2391
968
default_stems_gray	:= $(addsuffix ._gray_,$(default_stems_ss))
2392
969
default_stems_sg	:= $(sort $(default_stems_script) $(default_stems_gray))
2393
970
default_stems_ssg	:= $(sort $(default_stems_ss) $(default_stems_gray))
2394
971
2395
972
stems_source		:= $(call concat-stems,tex)
2396
973
stems_script		:= $(call concat-stems,tex.sh rst)
2397
974
stems_graphic		:= $(call concat-stems,fig gpi eps.gz xvg svg png jpg dot)
2398
975
stems_gray_graphic	:= $(addsuffix ._gray_,\
2399
976
	$(stems_graphic) $(all_stems.eps))
2400
977
stems_gg		:= $(sort $(stems_graphic) $(stems_gray_graphic))
2401
978
stems_ss		:= $(sort $(stems_source) $(stems_script))
2402
979
stems_gray		:= $(addsuffix ._gray_,$(stems_ss))
2403
980
stems_sg		:= $(sort $(stems_script) $(stems_gray))
2404
981
stems_ssg		:= $(sort $(stems_ss) $(stems_gray))
2405
982
2406
983
# Calculate names that can generate the need for an include file.  We can't
2407
984
# really do this with patterns because it's too easy to screw up, so we create
2408
985
# an exhaustive list.
2409
986
allowed_source_suffixes	:= \
2410
987
	pdf \
2411
988
	ps \
2412
989
	dvi \
2413
990
	ind \
2414
991
	nls \
2415
992
	bbl \
2416
993
	aux \
2417
994
	aux.make \
2418
995
	d \
2419
996
	tex \
2420
997
	auxbbl.make \
2421
998
	_graphics \
2422
999
	_show
2423
1000
allowed_source_patterns		:= $(addprefix %.,$(allowed_source_suffixes))
2424
1001
2425
1002
allowed_graphic_suffixes	:= \
2426
1003
	eps \
2427
1004
	gpihead.make \
2428
1005
	gpi.d
2429
1006
allowed_graphic_patterns	:= $(addprefix %.,$(allowed_graphic_suffixes))
2430
1007
2431
1008
# All targets allowed to build documents
2432
1009
allowed_source_targets	:= \
2433
1010
	$(foreach suff,$(allowed_source_suffixes),\
2434
1011
	$(addsuffix .$(suff),$(stems_ssg)))
2435
1012
2436
1013
# All targets allowed to build graphics
2437
1014
allowed_graphic_targets	:= \
2438
1015
	$(foreach suff,$(allowed_graphic_suffixes),\
2439
1016
	$(addsuffix .$(suff),$(stems_gg)))
2440
1017
2441
1018
# All targets that build multiple documents (like 'all')
2442
1019
allowed_batch_source_targets	:= \
2443
1020
	all \
2444
1021
	all-pdf \
2445
1022
	all-ps \
2446
1023
	all-dvi \
2447
1024
	all-bbl \
2448
1025
	all-ind \
2449
1026
	all-gls \
2450
1027
	all-nls \
2451
1028
	show
2452
1029
2453
1030
# All targets that build multiple graphics (independent of document)
2454
1031
allowed_batch_graphic_targets	:= \
2455
1032
	all-graphics \
2456
1033
	all-pstex \
2457
1034
	all-dot2tex \
2458
1035
	all-gray-pstex \
2459
1036
	show-graphics
2460
1037
2461
1038
# Now we figure out which stuff is available as a make target for THIS RUN.
2462
1039
real_goals	:= $(call get-default,$(filter-out _includes,$(MAKECMDGOALS)),\
2463
1040
			all)
2464
1041
2465
1042
specified_source_targets	:= $(strip \
2466
1043
	$(filter $(allowed_source_targets) $(stems_ssg),$(real_goals)) \
2467
1044
	)
2468
1045
2469
1046
specified_batch_source_targets	:= $(strip \
2470
1047
	$(filter $(allowed_batch_source_targets),$(real_goals)) \
2471
1048
	)
2472
1049
2473
1050
specified_graphic_targets	:= $(strip \
2474
1051
	$(filter $(allowed_graphic_targets),$(real_goals)) \
2475
1052
	)
2476
1053
2477
1054
specified_batch_graphic_targets	:= $(strip \
2478
1055
	$(filter $(allowed_batch_graphic_targets),$(real_goals)) \
2479
1056
	)
2480
1057
2481
1058
specified_gpi_targets	:= $(patsubst %.gpi,%.eps,\
2482
1059
	$(filter $(patsubst %.eps,%.gpi,$(specified_graphic_targets)),\
2483
1060
		$(all_files.gpi)) \
2484
1061
	)
2485
1062
2486
1063
# Determine which .d files need including from the information gained above.
2487
1064
# This is done by first checking whether a batch target exists.  If it does,
2488
1065
# then all *default* stems are used to create possible includes (nobuild need
2489
1066
# not apply for batch status).  If no batch targets exist, then the individual
2490
1067
# targets are considered and appropriate includes are taken from them.
2491
1068
source_stems_to_include	:= \
2492
1069
	$(sort\
2493
1070
	$(if $(specified_batch_source_targets),\
2494
1071
		$(default_stems_ss),\
2495
1072
		$(foreach t,$(specified_source_targets),\
2496
1073
		$(foreach p,$(allowed_source_patterns),\
2497
1074
			$(patsubst $p,%,$(filter $p $(stems_ssg),$t)) \
2498
1075
		)) \
2499
1076
	))
2500
1077
2501
1078
# Determine which .gpi.d files are needed using the above information.  We
2502
1079
# first check whether a batch target is specified, then check individual
2503
1080
# graphics that may have been specified.
2504
1081
graphic_stems_to_include	:= \
2505
1082
	$(sort\
2506
1083
	$(if $(specified_batch_graphic_targets),\
2507
1084
		$(default_stems.gpi),\
2508
1085
		$(foreach t,$(specified_gpi_targets),\
2509
1086
		$(foreach p,$(allowed_graphic_patterns),\
2510
1087
			$(patsubst $p,%,$(filter $p,$t)) \
2511
1088
		)) \
2512
1089
	))
2513
1090
2514
1091
# All dependencies for the 'all' targets
2515
1092
all_pdf_targets		:= $(addsuffix .pdf,$(stems_ssg))
2516
1093
all_ps_targets		:= $(addsuffix .ps,$(stems_ssg))
2517
1094
all_dvi_targets		:= $(addsuffix .dvi,$(stems_ssg))
2518
1095
all_tex_targets		:= $(addsuffix .tex,$(stems_sg))
2519
1096
all_d_targets		:= $(addsuffix .d,$(stems_ssg))
2520
1097
all_graphics_targets	:= $(addsuffix .eps,$(stems_gg))
2521
1098
all_pstex_targets	:= $(addsuffix .pstex_t,$(stems.fig))
2522
1099
all_gray_pstex_targets	:= $(addsuffix ._gray_.pstex_t,$(stems.fig))
2523
1100
all_dot2tex_targets	:= $(addsuffix .dot_t,$(stems.dot))
2524
1101
2525
1102
all_known_graphics	:= $(sort $(all_graphics_targets) $(wildcard *.eps))
2526
1103
2527
1104
default_pdf_targets	:= $(addsuffix .pdf,$(default_stems_ss))
2528
1105
default_ps_targets	:= $(addsuffix .ps,$(default_stems_ss))
2529
1106
default_dvi_targets	:= $(addsuffix .dvi,$(default_stems_ss))
2530
1107
2531
1108
# Extensions generated by LaTeX invocation that can be removed when complete
2532
1109
rm_ext		:= \
2533
1110
	log *.log aux dvi ps pdf blg bbl out nav snm toc lof lot lol pfg \
2534
1111
	fls vrb idx ind ilg glg glo gls lox nls nlo nlg brf mtc maf
2535
1112
backup_patterns	:= *~ *.bak *.backup body.tmp head.tmp
2536
1113
2537
1114
graph_stem	:= _graph
2538
1115
2539
1116
# All LaTeX-generated files that can be safely removed
2540
1117
2541
1118
rm_tex := \
2542
1119
	$(foreach e,$(rm_ext),$(addsuffix .$e,$(all_stems_source))) \
2543
1120
	$(foreach e,$(rm_ext) tex,$(addsuffix .$e,$(all_stems_sg))) \
2544
1121
	$(addsuffix .log,$(all_ps_targets) $(all_pdf_targets)) \
2545
1122
	$(addsuffix .*.log,$(stems_graphic))
2546
1123
2547
1124
# These are the files that will affect .gpi transformation for all .gpi files.
2548
1125
#
2549
1126
# Use only the first one found.  Backward compatible values are at the end.
2550
1127
# Note that we use foreach, even though wildcard also returns a list, to ensure
2551
1128
# that the order in the uppercase variables is preserved.  Directory listings
2552
1129
# provide no such guarantee, so we avoid relying on them.
2553
1130
gpi_sed		:= $(strip \
2554
1131
	$(firstword $(foreach f,$(GNUPLOT_SED),$(wildcard $f))))
2555
1132
gpi_global	:= $(strip \
2556
1133
	$(firstword $(foreach f,$(GNUPLOT_GLOBAL),$(wildcard $f))))
2557
1134
2558
1135
#
2559
1136
# Functions used in generating output
2560
1137
#
2561
1138
2562
1139
# Outputs all source dependencies to stdout.  The first argument is the file to
2563
1140
# be parsed, the second is a list of files that will show up as dependencies in
2564
1141
# the new .d file created here.
2565
1142
#
2566
1143
# NOTE: BSD sed does not understand \|, so we have to do something more
2567
1144
# clunky to extract suitable extensions.
2568
1145
#
2569
1146
# Also, we do a little bit of funny rewriting up front (TARGETS=) to make sure
2570
1147
# that we can properly backslash-escape spaces in file names (e.g, on Cygwin
2571
1148
# for tex distributions that have "Program Files" in their name).
2572
1149
#
2573
1150
# $(call get-inputs,<parsed file>,<target files>)
2574
1151
define get-inputs
2575
1152
$(SED) \
2576
1153
-e '/^INPUT/!d' \
2577
1154
-e 's!^INPUT \(\./\)\{0,1\}!TARGETS=!' \
2578
1155
-e 's/[[:space:]]/\\ /g' \
2579
1156
-e 's/^TARGETS=/$2: /' \
2580
1157
-e '/\.tex$$/p' \
2581
1158
-e '/\.cls$$/p' \
2582
1159
-e '/\.sty$$/p' \
2583
1160
-e '/\.pstex_t$$/p' \
2584
1161
-e '/\.dot_t$$/p' \
2585
1162
-e 'd' \
2586
1163
$1 | $(SORT) | $(UNIQ)
2587
1164
endef
2588
1165
2589
1166
# Outputs all of the graphical dependencies to stdout.  The first argument is
2590
1167
# the stem of the source file being built, the second is a list of suffixes
2591
1168
# that will show up as dependencies in the generated .d file.
2592
1169
#
2593
1170
# Note that we try to escape spaces in filenames where possible.  We have to do
2594
1171
# it with three backslashes so that as the name percolates through the makefile
2595
1172
# it eventually ends up with the proper escaping when the build rule is found.
2596
1173
# Ugly, but it appears to work.  Note that graphicx doesn't allow filenames
2597
1174
# with spaces, so this could in many ways be moot unless you're using something
2598
1175
# like grffile.
2599
1176
#
2600
1177
# $(call get-graphics,<parsed file>,<target files>)
2601
1178
define get-graphics
2602
1179
$(SED) \
2603
1180
-e '/^File:/!d' \
2604
1181
-e 'N' \
2605
1182
-e 's/\n//g' \
2606
1183
-e '/Graphic file/!d' \
2607
1184
-e 's/^File: //' \
2608
1185
-e 's/ Graphic.*$$//' \
2609
1186
-e '/^\(.*\)\(\.[^.]*\)$$/{' \
2610
1187
-e   's//TARGETS=\1\2/' \
2611
1188
-e   's/[[:space:]]/\\\\\\&/g' \
2612
1189
-e   's/^TARGETS=/$2: /' \
2613
1190
-e   'p' \
2614
1191
-e   's/[^:]*: \(.*\)\(\.[^.]*\)$$/-include \1.gpi.d/' \
2615
1192
-e   'p' \
2616
1193
-e   'd' \
2617
1194
-e '}' \
2618
1195
$1 | $(SORT) | $(UNIQ)
2619
1196
endef
2620
1197
2621
1198
# Checks for build failure due to pstex inclusion, and gives instructions.
2622
1199
#
2623
1200
# $(call die-on-pstexs,<parsed file>)
2624
1201
define die-on-pstexs
2625
1202
if $(EGREP) -q '^! LaTeX Error: File .*\.pstex.* not found' $1; then \
2626
1203
	$(ECHO) "$(C_ERROR)Missing pstex_t file(s)$(C_RESET)"; \
2627
1204
	$(ECHO) "$(C_ERROR)Please run$(C_RESET)"; \
2628
1205
	$(ECHO) "$(C_ERROR)  make all-pstex$(C_RESET)"; \
2629
1206
	$(ECHO) "$(C_ERROR)before proceeding.$(C_RESET)"; \
2630
1207
	exit 1; \
2631
1208
fi
2632
1209
endef
2633
1210
2634
1211
# Checks for build failure due to dot2tex, and gives instructions.
2635
1212
#
2636
1213
# $(call die-on-dot2tex,<parsed file>)
2637
1214
define die-on-dot2tex
2638
1215
if $(EGREP) -q '^! LaTeX Error: File .*\.dot_t.* not found' $1; then \
2639
1216
	$(ECHO) "$(C_ERROR)Missing dot_t file(s)$(C_RESET)"; \
2640
1217
	$(ECHO) "$(C_ERROR)Please run$(C_RESET)"; \
2641
1218
	$(ECHO) "$(C_ERROR)  make all-dot2tex$(C_RESET)"; \
2642
1219
	$(ECHO) "$(C_ERROR)before proceeding.$(C_RESET)"; \
2643
1220
	exit 1; \
2644
1221
fi
2645
1222
endef
2646
1223
2647
1224
# Outputs all index files to stdout.  Arg 1 is the source file stem, arg 2 is
2648
1225
# the list of targets for the discovered dependency.
2649
1226
#
2650
1227
# $(call get-log-index,<log file stem>,<target files>)
2651
1228
define get-log-index
2652
1229
$(SED) \
2653
1230
-e 's/^No file \(.*\.ind\)\.$$/TARGETS=\1/' \
2654
1231
-e 's/^No file \(.*\.[gn]ls\)\.$$/TARGETS=\1/' \
2655
1232
-e 's/[[:space:]]/\\&/g' \
2656
1233
-e '/^TARGETS=/{' \
2657
1234
-e '  h' \
2658
1235
-e '  s/^TARGETS=/$2: /p' \
2659
1236
-e '  g' \
2660
1237
-e '  s/^TARGETS=\(.*\)/\1: $1.tex/p' \
2661
1238
-e '}' \
2662
1239
-e 'd' \
2663
1240
'$1.log' | $(SORT) | $(UNIQ)
2664
1241
endef
2665
1242
2666
1243
2667
1244
# Outputs all bibliography files to stdout.  Arg 1 is the source stem, arg 2 is
2668
1245
# a list of targets for each dependency found.
2669
1246
#
2670
1247
# The script kills all lines that do not contain bibdata.  Remaining lines have
2671
1248
# the \bibdata macro and delimiters removed to create a dependency list.  A
2672
1249
# trailing comma is added, then all adjacent commas are collapsed into a single
2673
1250
# comma.  Then commas are replaced with the string .bib[space], and the
2674
1251
# trailing space is killed off.  Finally, all filename spaces are escaped.
2675
1252
# This produces a list of space-delimited .bib filenames, which is what the
2676
1253
# make dep file expects to see.
2677
1254
#
2678
1255
# $(call get-bibs,<aux file>,<targets>)
2679
1256
define get-bibs
2680
1257
$(SED) \
2681
1258
-e '/^\\bibdata/!d' \
2682
1259
-e 's/\\bibdata{\([^}]*\)}/\1,/' \
2683
1260
-e 's/,\{2,\}/,/g' \
2684
1261
-e 's/[[:space:]]/\\&/g' \
2685
1262
-e 's/,/.bib /g' \
2686
1263
-e 's/ \{1,\}$$//' \
2687
1264
$1 | $(XARGS) $(KPSEWHICH) | \
2688
1265
$(SED) \
2689
1266
-e 's/^/$2: /' | \
2690
1267
\$(SORT) | $(UNIQ)
2691
1268
endef
2692
1269
2693
1270
# Makes a an aux file that only has stuff relevant to the dvi in it
2694
1271
# $(call make-auxdvi-file,<flattened-aux>,<new-aux>)
2695
1272
define make-auxdvi-file
2696
1273
$(SED) \
2697
1274
-e '/^\\newlabel/!d' \
2698
1275
$1 > $2
2699
1276
endef
2700
1277
2701
1278
# Makes an aux file that only has stuff relevant to the bbl in it
2702
1279
# $(call make-auxbbl-file,<flattened-aux>,<new-aux>)
2703
1280
define make-auxbbl-file
2704
1281
$(SED) \
2705
1282
-e '/^\\newlabel/d' \
2706
1283
$1 > $2
2707
1284
endef
2708
1285
2709
1286
# Makes a .gpi.d file from a .gpi file
2710
1287
# $(call make-gpi-d,<.gpi>,<.gpi.d>)
2711
1288
define make-gpi-d
2712
1289
$(ECHO) '# vim: ft=make' > $2; \
2713
1290
$(ECHO) 'ifndef INCLUDED_$(call cleanse-filename,$2)' >> $2; \
2714
1291
$(ECHO) 'INCLUDED_$(call cleanse-filename,$2) = 1' >> $2; \
2715
1292
$(call get-gpi-deps,$1,$(addprefix $(2:%.gpi.d=%).,eps gpi.d)) >> $2; \
2716
1293
$(ECHO) 'endif' >> $2;
2717
1294
endef
2718
1295
2719
1296
# Parse .gpi files for data and loaded dependencies, output to stdout
2720
1297
#
2721
1298
# The sed script here tries to be clever about obtaining valid
2722
1299
# filenames from the gpi file.  It assumes that the plot command starts its own
2723
1300
# line, which is not too difficult a constraint to satisfy.
2724
1301
#
2725
1302
# This command script also generates 'include' directives for every 'load'
2726
1303
# command in the .gpi file.  The load command must appear on a line by itself
2727
1304
# and the file it loads must have the suffix .gpi.  If you don't want it to be
2728
1305
# compiled when running make graphics, then give it a suffix of ._include_.gpi.
2729
1306
#
2730
1307
# $(call get-gpi-deps,<gpi file>,<targets>)
2731
1308
define get-gpi-deps
2732
1309
$(SED) \
2733
1310
-e '/^[[:space:]]*s\{0,1\}plot/,/[^\\]$$/{' \
2734
1311
-e ' H' \
2735
1312
-e ' /[^\\]$$/{' \
2736
1313
-e '  s/.*//' \
2737
1314
-e '  x' \
2738
1315
-e '  s/\\\{0,1\}\n//g' \
2739
1316
-e '  s/^[[:space:]]*s\{0,1\}plot[[:space:]]*\(\[[^]]*\][[:space:]]*\)*/,/' \
2740
1317
-e '  s/[[:space:]]*\(['\''"][^'\''"]*['\''"]\)\{0,1\}[^,]*/\1/g' \
2741
1318
-e '  s/,['\''"]-\{0,1\}['\''"]//g' \
2742
1319
-e '  s/[,'\''"]\{1,\}/ /g' \
2743
1320
-e '  s!.*!$2: &!' \
2744
1321
-e '  p' \
2745
1322
-e ' }' \
2746
1323
-e ' d' \
2747
1324
-e '}' \
2748
1325
-e 's/^[[:space:]]*load[[:space:]]*['\''"]\([^'\''"]*\.gpi\)['\''"].*$$/-include \1.d/p' \
2749
1326
-e 'd' \
2750
1327
$1
2751
1328
endef
2752
1329
2753
1330
# Colorizes real, honest-to-goodness LaTeX errors that can't be overcome with
2754
1331
# recompilation.
2755
1332
#
2756
1333
# Note that we only ignore file not found errors for things that we know how to
2757
1334
# build, like graphics files.
2758
1335
#
2759
1336
# $(call colorize-latex-errors,<log file>)
2760
1337
define colorize-latex-errors
2761
1338
$(SED) \
2762
1339
-e '/^! LaTeX Error: File .*eps'"'"' not found\.$$/d' \
2763
1340
-e '/^! LaTeX Error: Cannot determine size/d' \
2764
1341
-e '/^! /,/^$$/{' \
2765
1342
-e '  H' \
2766
1343
-e '  /^$$/{' \
2767
1344
-e '    x' \
2768
1345
-e '    s/^.*$$/$(C_ERROR)&$(C_RESET)/' \
2769
1346
-e '    p' \
2770
1347
-e '  }' \
2771
1348
-e '}' \
2772
1349
-e 'd' \
2773
1350
$1
2774
1351
endef
2775
1352
2776
1353
# Colorize Makeindex errors
2777
1354
define colorize-makeindex-errors
2778
1355
$(SED) \
2779
1356
-e '/^!! /{' \
2780
1357
-e '  N' \
2781
1358
-e '  s/^.*$$/$(C_ERROR)&$(C_RESET)/' \
2782
1359
-e '  p' \
2783
1360
-e '}' \
2784
1361
-e 'd' \
2785
1362
$1
2786
1363
endef
2787
1364
2788
1365
# Colorize GNUplot errors
2789
1366
#
2790
1367
# $(call colorize-gnuplot-errors,<log file>)
2791
1368
define colorize-gnuplot-errors
2792
1369
$(SED) \
2793
1370
-e '/^gnuplot>/,/^$$/{' \
2794
1371
-e '  s/^gnuplot.*/$(C_ERROR)&/' \
2795
1372
-e '  s/^$$/$(C_RESET)/' \
2796
1373
-e '  p' \
2797
1374
-e '}' \
2798
1375
-e 'd' \
2799
1376
$1
2800
1377
endef
2801
1378
2802
1379
# Colorize GraphViz errors
2803
1380
#
2804
1381
# $(call colorize-dot-errors,<log file>)
2805
1382
define colorize-dot-errors
2806
1383
$(SED) \
2807
1384
-e '/^Error:/,/context:/s/.*/$(C_ERROR)&$(C_RESET)/p' \
2808
1385
-e 's/^Warning:.*/$(C_WARNING)&$(C_RESET)/p' \
2809
1386
-e 'd' \
2810
1387
'$1'
2811
1388
endef
2812
1389
2813
1390
# Get all important .aux files from the top-level .aux file and merges them all
2814
1391
# into a single file, which it outputs to stdout.
2815
1392
#
2816
1393
# $(call flatten-aux,<toplevel aux>,<output file>)
2817
1394
define flatten-aux
2818
1395
$(SED) \
2819
1396
-e '/\\@input{\(.*\)}/{' \
2820
1397
-e     's//\1/' \
2821
1398
-e     's![.:]!\\&!g' \
2822
1399
-e     'h' \
2823
1400
-e     's!.*!\\:\\\\@input{&}:{!' \
2824
1401
-e     'p' \
2825
1402
-e     'x' \
2826
1403
-e     's/\\././g' \
2827
1404
-e     's/.*/r &/p' \
2828
1405
-e     's/.*/d/p' \
2829
1406
-e     's/.*/}/p' \
2830
1407
-e     'd' \
2831
1408
-e '}' \
2832
1409
-e 'd' \
2833
1410
'$1' > "$1.$$$$.sed.make"; \
2834
1411
$(SED) -f "$1.$$$$.sed.make" '$1' > "$1.$$$$.make"; \
2835
1412
$(SED) \
2836
1413
-e '/^\\relax/d' \
2837
1414
-e '/^\\bibcite/d' \
2838
1415
-e 's/^\(\\newlabel{[^}]\{1,\}}\).*/\1/' \
2839
1416
"$1.$$$$.make" | $(SORT) > '$2'; \
2840
1417
$(call remove-temporary-files,$1.$$$$.make $1.$$$$.sed.make)
2841
1418
endef
2842
1419
2843
1420
# Generate pdf from postscript
2844
1421
#
2845
1422
# Note that we don't just call ps2pdf, since there are so many versions of that
2846
1423
# script on various systems.  Instead, we call the postscript interpreter
2847
1424
# directly.
2848
1425
#
2849
1426
# $(call ps2pdf,infile,outfile,[embed fonts])
2850
1427
define ps2pdf
2851
1428
	$(GS) \
2852
1429
		-dSAFER -dCompatibilityLevel=$(PS_COMPATIBILITY) \
2853
1430
		$(if $3,$(PS_EMBED_OPTIONS)) \
2854
1431
		-q -dNOPAUSE -dBATCH \
2855
1432
		-sDEVICE=pdfwrite -sstdout=%stderr \
2856
1433
		'-sOutputFile=$2' \
2857
1434
		-dSAFER -dCompatibilityLevel=$(PS_COMPATIBILITY) \
2858
1435
		$(if $3,$(PS_EMBED_OPTIONS)) \
2859
1436
		-c .setpdfwrite \
2860
1437
		-f '$1'
2861
1438
endef
2862
1439
2863
1440
# Colorize LaTeX output.
2864
1441
# This uses a neat trick from the Sed & Awk Book from O'Reilly:
2865
1442
# 1) If a line has a single ending paren, delete it to make a blank line (so
2866
1443
#	that we catch the first error, which is not always preceded by a blank
2867
1444
#	line).
2868
1445
# 2) Ensure that the last line of the file gets appended to the hold buffer,
2869
1446
# 	and blank it out to trigger end-of-paragraph logic below.
2870
1447
# 3) When encountering a blank line (LaTeX output helpfully breaks output on
2871
1448
# 	newlines)
2872
1449
# 	a) swap the hold buffer (containing the paragraph) into the pattern buffer (putting a blank line into the hold buffer),
2873
1450
# 	b) remove the newline at the beginning (don't ask),
2874
1451
# 	c) apply any colorizing substitutions necessary to ensure happiness.
2875
1452
# 	d) get the newline out of the hold buffer and append it
2876
1453
# 	e) profit! (print)
2877
1454
# 4) Anything not colorized is deleted, unless in verbose mode.
2878
1455
color_tex	:= \
2879
1456
	$(SED) \
2880
1457
	-e '$${' \
2881
1458
	-e '  /^$$/!{' \
2882
1459
	-e '    H' \
2883
1460
	-e '    s/.*//' \
2884
1461
	-e '  }' \
2885
1462
	-e '}' \
2886
1463
	-e '/^$$/!{' \
2887
1464
	-e '  H' \
2888
1465
	-e '  d' \
2889
1466
	-e '}' \
2890
1467
	-e '/^$$/{' \
2891
1468
	-e '  x' \
2892
1469
	-e '  s/^\n//' \
2893
1470
	-e '  /Output written/{' \
2894
1471
	-e '    s/.*(\([^)]\{1,\}\)).*/Success!  Wrote \1/' \
2895
1472
	-e '    s/[[:digit:]]\{1,\}/$(C_PAGES)&$(C_RESET)/g' \
2896
1473
	-e '    s/Success!/$(C_SUCCESS)&$(C_RESET)/g' \
2897
1474
	-e '    b end' \
2898
1475
	-e '  }' \
2899
1476
	-e '  /! *LaTeX Error:.*/{' \
2900
1477
	-e '    s/.*\(! *LaTeX Error:.*\)/$(C_ERROR)\1$(C_RESET)/' \
2901
1478
	-e '    b end' \
2902
1479
	-e '  }' \
2903
1480
	-e '  /.*Warning:.*/{' \
2904
1481
	-e '    s//$(C_WARNING)&$(C_RESET)/' \
2905
1482
	-e '    b end' \
2906
1483
	-e '  }' \
2907
1484
	-e '  /Underfull.*/{' \
2908
1485
	-e '    s/.*\(Underfull.*\)/$(C_UNDERFULL)\1$(C_RESET)/' \
2909
1486
	-e '    b end' \
2910
1487
	-e '  }' \
2911
1488
	-e '  /Overfull.*/{' \
2912
1489
	-e '    s/.*\(Overfull.*\)/$(C_OVERFULL)\1$(C_RESET)/' \
2913
1490
	-e '    b end' \
2914
1491
	-e '  }' \
2915
1492
	$(if $(VERBOSE),,-e '  d') \
2916
1493
	-e '  :end' \
2917
1494
	-e '  G' \
2918
1495
	-e '}' \
2919
1496
2920
1497
# Colorize BibTeX output.
2921
1498
color_bib	:= \
2922
1499
	$(SED) \
2923
1500
	-e 's/^Warning--.*/$(C_WARNING)&$(C_RESET)/' -e 't' \
2924
1501
	-e '/---/,/^.[^:]/{' \
2925
1502
	-e '  H' \
2926
1503
	-e '  /^.[^:]/{' \
2927
1504
	-e '    x' \
2928
1505
	-e '    s/\n\(.*\)/$(C_ERROR)\1$(C_RESET)/' \
2929
1506
	-e '	p' \
2930
1507
	-e '    s/.*//' \
2931
1508
	-e '    h' \
2932
1509
	-e '    d' \
2933
1510
	-e '  }' \
2934
1511
	-e '  d' \
2935
1512
	-e '}' \
2936
1513
	-e '/(.*error.*)/s//$(C_ERROR)&$(C_RESET)/' \
2937
1514
	$(if $(VERBOSE),,-e 'd')
2938
1515
2939
1516
2940
1517
# Make beamer output big enough to print on a full page.  Landscape doesn't
2941
1518
# seem to work correctly.
2942
1519
enlarge_beamer	= $(PSNUP) -l -1 -W128mm -H96mm -pletter
2943
1520
2944
1521
# $(call test-run-again,<source stem>)
2945
1522
test-run-again	= $(EGREP) -q '^(.*Rerun .*|No file $1\.[^.]+\.)$$' $1.log
2946
1523
2947
1524
# This tests whether the dvi target should be run at all, from viewing the log
2948
1525
# file.
2949
1526
# $(call test-log-for-need-to-run,<source stem>)
2950
1527
define test-log-for-need-to-run
2951
1528
$(SED) \
2952
1529
-e '/^No file $(call escape-dots,$1)\.aux\./d' \
2953
1530
$1.log \
2954
1531
| $(EGREP) -q '^(.*Rerun .*|No file $1\.[^.]+\.|LaTeX Warning: File.*)$$'
2955
1532
endef
2956
1533
2957
1534
# LaTeX invocations
2958
1535
#
2959
1536
# $(call latex,<tex file>,[<extra LaTeX args>])
2960
1537
run-latex	= $(LATEX) --interaction=batchmode $(if $2,$2,) $1 > /dev/null
2961
1538
2962
1539
# $(call latex-color-log,<LaTeX stem>)
2963
1540
latex-color-log	= $(color_tex) $1.log
2964
1541
2965
1542
# $(call run-makeindex,<input>,<output>,<log>,<extra flags>)
2966
1543
define run-makeindex
2967
1544
success=1; \
2968
1545
if ! $(MAKEINDEX) -q $1 -t $3 -o $2 $4 > /dev/null || $(EGREP) -q '^!!' $3; then \
2969
1546
	$(call colorize-makeindex-errors,$3); \
2970
1547
	success=0; \
2971
1548
fi; \
2972
1549
[ "$$success" = "1" ] && $(sh_true) || $(sh_false);
2973
1550
endef
2974
1551
2975
1552
# BibTeX invocations
2976
1553
#
2977
1554
# $(call run-bibtex,<tex stem>)
2978
1555
run-bibtex	= $(BIBTEX) $1 | $(color_bib)
2979
1556
2980
1557
2981
1558
# $(call convert-gpi,<gpi file>,<eps file>,[gray])
2982
1559
define convert-gpi
2983
1560
$(ECHO) 'set terminal postscript enhanced eps' \
2984
1561
$(call get-default,$(strip \
2985
1562
$(firstword \
2986
1563
	$(shell \
2987
1564
		$(SED) \
2988
1565
			-e 's/^\#\#FONTSIZE=\([[:digit:]]\{1,\}\)/\1/p' \
2989
1566
			-e 'd' \
2990
1567
			$1 $(strip $(gpi_global)) \
2991
1568
	) \
2992
1569
) \
2993
1570
),22) \
2994
1571
$(strip $(if $3,monochrome,$(if \
2995
1572
$(shell $(EGREP) '^\#\#[[:space:]]*GRAY[[:space:]]*$$' $< $(gpi_global)),\
2996
1573
,color))) > $1head.make; \
2997
1574
$(ECHO) 'set output "$2"' >> $1head.make; \
2998
1575
$(if $(gpi_global),$(CAT) $(gpi_global) >> $1head.make;,) \
2999
1576
fnames='$1head.make $1';\
3000
1577
$(if $(gpi_sed),\
3001
1578
	$(SED) -f '$(gpi_sed)' $$fnames > $1.temp.make; \
3002
1579
	fnames=$1.temp.make;,\
3003
1580
) \
3004
1581
success=1; \
3005
1582
if ! $(GNUPLOT) $$fnames 2>$1.log; then \
3006
1583
	$(call colorize-gnuplot-errors,$1.log); \
3007
1584
	success=0; \
3008
1585
fi; \
3009
1586
$(if $(gpi_sed),$(call remove-temporary-files,$1.temp.make);,) \
3010
1587
$(call remove-temporary-files,$1head.make); \
3011
1588
[ "$$success" = "1" ] && $(sh_true) || $(sh_false);
3012
1589
endef
3013
1590
3014
1591
# Creation of .eps files from .png files
3015
1592
#
3016
1593
# The intermediate step of PNM (using NetPBM) produces much nicer output than
3017
1594
# ImageMagick's "convert" binary.  I couldn't get the right combination of
3018
1595
# flags to make it look nice, anyway.
3019
1596
#
3020
1597
# To handle gray scale conversion, we pipe things through ppmtopgm in the
3021
1598
# middle.
3022
1599
#
3023
1600
# $(call convert-png,<png file>,<eps file>)
3024
1601
define convert-png
3025
1602
$(PNGTOPNM) "$1" \
3026
1603
	$(if $3,| $(PPMTOPGM),) \
3027
1604
	| $(PNMTOPS) -noturn \
3028
1605
	> "$2"
3029
1606
endef
3030
1607
3031
1608
# Creation of .eps files from .jpg files
3032
1609
#
3033
1610
# Thanks to brubakee for this solution.
3034
1611
#
3035
1612
# Uses Postscript level 2 to avoid file size bloat
3036
1613
# $(call convert-jpg,<jpg file>,<eps file>)
3037
1614
define convert-jpg
3038
1615
$(CONVERT) $(if $3,-type Grayscale,) '$1' eps2:'$2'
3039
1616
endef
3040
1617
3041
1618
# Creation of .eps files from .fig files
3042
1619
# $(call convert-fig,<fig file>,<eps file>,[gray])
3043
1620
convert-fig	= $(FIG2DEV) -L eps $(if $3,-N,) $1 $2
3044
1621
3045
1622
# Creation of .pstex files from .fig files
3046
1623
# $(call convert-fig-pstex,<fig file>,<pstex file>)
3047
1624
convert-fig-pstex	= $(FIG2DEV) -L pstex $1 $2 > /dev/null 2>&1
3048
1625
3049
1626
# Creation of .pstex_t files from .fig files
3050
1627
# $(call convert-fig-pstex-t,<fig file>,<pstex file>,<pstex_t file>)
3051
1628
convert-fig-pstex-t	= $(FIG2DEV) -L pstex_t -p $3 $1 $2 > /dev/null 2>&1
3052
1629
3053
1630
# Creation of .dot_t files from .dot files
3054
1631
# #(call convert-dot-tex,<dot file>,<dot_t file>)
3055
1632
convert-dot-tex		= $(DOT2TEX) '$1' > '$2'
3056
1633
3057
1634
# Creation of .tex files from .rst files
3058
1635
# TODO: Fix paper size so that it can be specified in the file itself
3059
1636
# $(call convert-rst,<rst file>,<tex file>)
3060
1637
rst_style_file=$(wildcard _rststyle_._include_.tex)
3061
1638
define convert-rst
3062
1639
$(RST2LATEX) \
3063
1640
	--documentoptions=letterpaper \
3064
1641
	$(if $(rst_style_file),--stylesheet=$(rst_style_file),) \
3065
1642
	$1 $2
3066
1643
endef
3067
1644
3068
1645
# Converts svg files into .eps files
3069
1646
#
3070
1647
# $(call convert-svg,<svg file>,<eps file>,[gray])
3071
1648
convert-svg	= $(INKSCAPE) --export-eps='$2' '$1'
3072
1649
3073
1650
# Converts xvg files into .eps files
3074
1651
#
3075
1652
# $(call convert-xvg,<xvg file>,<eps file>,[gray])
3076
1653
convert-xvg	= $(XMGRACE) '$1' -printfile - -hardcopy -hdevice EPS $(if $3,| $(call kill-ps-color)) > '$2'
3077
1654
3078
1655
# Converts .eps.gz files into .eps files
3079
1656
#
3080
1657
# $(call convert-epsgz,<eps.gz file>,<eps file>,[gray])
3081
1658
convert-epsgz	= $(GUNZIP) -c '$1' $(if $3,| $(call kill-ps-color)) > '$2'
3082
1659
3083
1660
# Converts .eps files into .eps files (usually a no-op, but can make grayscale)
3084
1661
#
3085
1662
# $(call convert-eps,<in file>,<out file>,[gray])
3086
1663
convert-eps	= $(if $3,$(call kill-ps-color) $1 > $2)
3087
1664
3088
1665
# The name of the file containing special postscript commands for grayscale
3089
1666
gray_eps_file	:= gray.eps.make
3090
1667
3091
1668
# Changes sethsbcolor and setrgbcolor calls in postscript to always produce
3092
1669
# grayscale.  In general, this is accomplished by writing new versions of those
3093
1670
# functions into the user dictionary space, which is looked up before the
3094
1671
# global or system dictionaries (userdict is one of the permanent dictionaries
3095
1672
# in postscript and is not read-only like systemdict).
3096
1673
#
3097
1674
# For setrgbcolor, the weighted average of the triple is computed and the
3098
1675
# triple is replaced with three copies of that average before the original
3099
1676
# procedure is called: .299R + .587G + .114B
3100
1677
#
3101
1678
# For sethsbcolor, the color is first converted to RGB, then to grayscale by
3102
1679
# the new setrgbcolor operator as described above.  Why is this done?
3103
1680
# Because simply using the value component will tend to make pure colors
3104
1681
# white, a very undesirable thing.  Pure blue should not translate to white,
3105
1682
# but to some level of gray.  Conversion to RGB does the right thing.  It's
3106
1683
# messy, but it works.
3107
1684
#
3108
1685
# From
3109
1686
# http://en.wikipedia.org/wiki/HSV_color_space#Transformation_from_HSV_to_RGB,
3110
1687
# HSB = HSV (Value = Brightness), and the formula used to convert to RGB is
3111
1688
# as follows:
3112
1689
#
3113
1690
# Hi = int(floor(6 * H)) mod 6
3114
1691
# f = 6 * H - Hi
3115
1692
# p = V(1-S)
3116
1693
# q = V(1-fS)
3117
1694
# t = V(1-(1-f)S)
3118
1695
# if Hi = 0: R G B <-- V t p
3119
1696
# if Hi = 1: R G B <-- q V p
3120
1697
# if Hi = 2: R G B <-- p V t
3121
1698
# if Hi = 3: R G B <-- p q V
3122
1699
# if Hi = 4: R G B <-- t p V
3123
1700
# if Hi = 5: R G B <-- V p q
3124
1701
#
3125
1702
# The messy stack-based implementation is below
3126
1703
# $(call create-gray-eps-file,filename)
3127
1704
define create-gray-eps-file
3128
1705
$(ECHO) -n -e '\
3129
1706
/OLDRGB /setrgbcolor load def\n\
3130
1707
/setrgbcolor {\n\
3131
1708
    .114 mul exch\n\
3132
1709
    .587 mul add exch\n\
3133
1710
    .299 mul add\n\
3134
1711
    dup dup\n\
3135
1712
    OLDRGB\n\
3136
1713
} bind def\n\
3137
1714
/OLDHSB /sethsbcolor load def\n\
3138
1715
/sethsbcolor {\n\
3139
1716
    2 index                     % H V S H\n\
3140
1717
    6 mul floor cvi 6 mod       % Hi V S H\n\
3141
1718
    3 index                     % H Hi V S H\n\
3142
1719
    6 mul                       % 6H Hi V S H\n\
3143
1720
    1 index                     % Hi 6H Hi V S H\n\
3144
1721
    sub                         % f Hi V S H\n\
3145
1722
    2 index 1                   % 1 V f Hi V S H\n\
3146
1723
    4 index                     % S 1 V f Hi V S H\n\
3147
1724
    sub mul                     % p f Hi V S H\n\
3148
1725
    3 index 1                   % 1 V p f Hi V S H\n\
3149
1726
    6 index                     % S 1 V p f Hi V S H\n\
3150
1727
    4 index                     % f S 1 V p f Hi V S H\n\
3151
1728
    mul sub mul                 % q p f Hi V S H\n\
3152
1729
    4 index 1 1                 % 1 1 V q p f Hi V S H\n\
3153
1730
    5 index                     % f 1 1 V q p f Hi V S H\n\
3154
1731
    sub                         % (1-f) 1 V q p f Hi V S H\n\
3155
1732
    8 index                     % S (1-f) 1 V q p f Hi V S H\n\
3156
1733
    mul sub mul                 % t q p f Hi V S H\n\
3157
1734
    4 -1 roll pop               % t q p Hi V S H\n\
3158
1735
    7 -2 roll pop pop           % t q p Hi V\n\
3159
1736
    5 -2 roll                   % Hi V t q p\n\
3160
1737
    dup 0 eq\n\
3161
1738
    {1 index 3 index 6 index}\n\
3162
1739
    {\n\
3163
1740
        dup 1 eq\n\
3164
1741
        {3 index 2 index 6 index}\n\
3165
1742
        {\n\
3166
1743
            dup 2 eq\n\
3167
1744
            {4 index 2 index 4 index}\n\
3168
1745
            {\n\
3169
1746
                dup 3 eq\n\
3170
1747
                {4 index 4 index 3 index}\n\
3171
1748
                {\n\
3172
1749
                    dup 4 eq\n\
3173
1750
                    {2 index 5 index 3 index}\n\
3174
1751
                    {\n\
3175
1752
                        dup 5 eq\n\
3176
1753
                        {1 index 5 index 5 index}\n\
3177
1754
                        {0 0 0}\n\
3178
1755
                        ifelse\n\
3179
1756
                    }\n\
3180
1757
                    ifelse\n\
3181
1758
                }\n\
3182
1759
                ifelse\n\
3183
1760
            }\n\
3184
1761
            ifelse\n\
3185
1762
        }\n\
3186
1763
        ifelse\n\
3187
1764
    }\n\
3188
1765
    ifelse                      % B G R Hi V t q p\n\
3189
1766
    setrgbcolor\n\
3190
1767
    5 {pop} repeat\n\
3191
1768
} bind def\n'\
3192
1769
> $1
3193
1770
endef
3194
1771
3195
1772
# This actually inserts the color-killing code into a postscript file
3196
1773
# $(call kill-ps-color)
3197
1774
define kill-ps-color
3198
1775
$(SED) -e '/%%EndComments/r $(gray_eps_file)'
3199
1776
endef
3200
1777
3201
1778
# Converts graphviz .dot files into .eps files
3202
1779
# Grayscale is not directly supported by dot, so we pipe it through fig2dev in
3203
1780
# that case.
3204
1781
# $(call convert-dot,<dot file>,<eps file>,<log file>,[gray])
3205
1782
define convert-dot
3206
1783
$(DOT) -Tps '$1' 2>'$3' $(if $4,| $(call kill-ps-color)) > $2; \
3207
1784
$(call colorize-dot-errors,$3)
3208
1785
endef
3209
1786
3210
1787
# Convert DVI to Postscript
3211
1788
# $(call make-ps,<dvi file>,<ps file>,<log file>,[<paper size>])
3212
1789
make-ps		= \
3213
1790
	$(DVIPS) -o '$2' $(if $(filter-out BEAMER,$4),-t$(firstword $4),) '$1' \
3214
1791
		$(if $(filter BEAMER,$4),| $(enlarge_beamer)) > $3 2>&1
3215
1792
3216
1793
# Convert Postscript to PDF
3217
1794
# $(call make-pdf,<ps file>,<pdf file>,<log file>,<embed file>)
3218
1795
make-pdf	= \
3219
1796
	$(call ps2pdf,$1,$2,$(filter 1,$(shell $(CAT) '$4'))) > '$3' 2>&1
3220
1797
3221
1798
# Display information about what is being done
3222
1799
# $(call echo-build,<output file>,[<run number>])
3223
1800
echo-build	= $(ECHO) "$(C_BUILD)= $1 --> $2$(if $3, ($3),) =$(C_RESET)"
3224
1801
echo-graphic	= $(ECHO) "$(C_GRAPHIC)= $1 --> $2 =$(C_RESET)"
3225
1802
echo-dep	= $(ECHO) "$(C_DEP)= $1 --> $2 =$(C_RESET)"
3226
1803
3227
1804
# Display a list of something
3228
1805
# $(call echo-list,<values>)
3229
1806
echo-list	= for x in $1; do $(ECHO) "$$x"; done
3230
1807
3231
1808
#
3232
1809
# DEFAULT TARGET
3233
1810
#
3234
1811
3235
1812
.PHONY: all
3236
1813
all: $(default_pdf_targets) ;
3237
1814
3238
1815
.PHONY: all-pdf
3239
1816
all-pdf: $(default_pdf_targets) ;
3240
1817
3241
1818
.PHONY: all-ps
3242
1819
all-ps: $(default_ps_targets) ;
3243
1820
3244
1821
.PHONY: all-dvi
3245
1822
all-dvi: $(default_dvi_targets) ;
3246
1823
3247
1824
#
3248
1825
# VIEWING TARGET
3249
1826
#
3250
1827
.PHONY: show
3251
1828
show: all
3252
1829
	$(QUIET)for x in $(default_pdf_targets); do \
3253
1830
		[ -e "$$x" ] && $(VIEW_PDF) $$x & \
3254
1831
	done
3255
1832
3256
1833
#
3257
1834
# INCLUDES
3258
1835
#
3259
1836
source_includes	:= $(addsuffix .d,$(source_stems_to_include))
3260
1837
graphic_includes := $(addsuffix .gpi.d,$(graphic_stems_to_include))
3261
1838
3262
1839
# Include only the dependencies used
3263
1840
ifneq "" "$(source_includes)"
3264
1841
include $(source_includes)$(call include-message,$(source_includes))
3265
1842
endif
3266
1843
ifneq "" "$(graphic_includes)"
3267
1844
include $(graphic_includes)$(call include-message,$(graphic_includes))
3268
1845
endif
3269
1846
3270
1847
#
3271
1848
# MAIN TARGETS
3272
1849
#
3273
1850
3274
1851
%: %.pdf ;
3275
1852
3276
1853
# This builds and displays the wanted file.
3277
1854
.PHONY: $(addsuffix ._show,$(stems_ssg))
3278
1855
%._show: %.pdf
3279
1856
	$(QUIET)$(VIEW_PDF) $< &
3280
1857
3281
1858
.SECONDARY: $(all_pdf_targets)
3282
1859
%.pdf: %.ps %.embed.make
3283
1860
	$(QUIET)$(call echo-build,$<,$@)
3284
1861
	$(QUIET)$(call make-pdf,$<,$@.temp,$@.log,$*.embed.make); \
3285
1862
	if [ x"$$?" = x"0" ]; then \
3286
1863
	    $(if $(VERBOSE),$(CAT) $@.log,:); \
3287
1864
	    $(RM) -f '$@'; \
3288
1865
	    $(MV) '$@.temp' '$@'; \
3289
1866
	    $(TOUCH) '$@'; \
3290
1867
	    $(call copy-with-logging,$@,$(BINARY_TARGET_DIR)); \
3291
1868
	else \
3292
1869
	    $(CAT) $@.log; \
3293
1870
	    $(call remove-temporary-files,'$@.temp'); \
3294
1871
	    $(sh_false); \
3295
1872
	fi
3296
1873
3297
1874
.SECONDARY: $(all_ps_targets)
3298
1875
%.ps: %.dvi %.paper.make
3299
1876
	$(QUIET)$(call echo-build,$<,$@)
3300
1877
	$(QUIET)$(call make-ps,$<,$@.temp,$@.log,\
3301
1878
			$(firstword $(shell $(CAT) $*.paper.make))); \
3302
1879
	if [ x"$$?" = x"0" ]; then \
3303
1880
	    $(if $(VERBOSE),$(CAT) $@.log,:); \
3304
1881
	    $(RM) -f '$@'; \
3305
1882
	    $(MV) '$@.temp' '$@'; \
3306
1883
	    $(TOUCH) '$@'; \
3307
1884
	    $(call copy-with-logging,$@,$(BINARY_TARGET_DIR)); \
3308
1885
	else \
3309
1886
	    $(CAT) $@.log; \
3310
1887
	    $(call remove-temporary-files,'$@.temp'); \
3311
1888
	    $(sh_false); \
3312
1889
	fi
3313
1890
3314
1891
# Build the final dvi file.  This is a very tricky rule because of the way that
3315
1892
# latex runs multiple times, needs graphics after the first run (or maybe
3316
1893
# already has them), and relies on bibliographies or indices that may not exist.
3317
1894
#
3318
1895
#	Check the log for fatal errors.  If they exist, colorize and bail.
3319
1896
#
3320
1897
#	Create the .auxdvi.cookie file.  (Needed for next time if not present)
3321
1898
#
3322
1899
#	If any of the following are true, we must rebuild at least one time:
3323
1900
#
3324
1901
#	* the .bbl was recently rebuilt
3325
1902
#
3326
1903
#		check a cookie, then delete it
3327
1904
#
3328
1905
#	* any of several output files was created or changed:
3329
1906
#
3330
1907
#		check $*.run.cookie, then delete it
3331
1908
#
3332
1909
#	* the .aux file changed in a way that necessitates attention
3333
1910
#
3334
1911
#		Note that if the .auxdvi.make file doesn't exist, this means
3335
1912
#		that we are doing a clean build, so it doesn't figure into the
3336
1913
#		test for running again.
3337
1914
#
3338
1915
#		compare against .auxdvi.make
3339
1916
#
3340
1917
#		move if different, remove if not
3341
1918
#
3342
1919
#	* the .log file has errors or warnings requiring at least one more run
3343
1920
#
3344
1921
#	We use a loop over a single item to simplify the process of breaking
3345
1922
#	out when we find one of the conditions to be true.
3346
1923
#
3347
1924
#	If we do NOT need to run latex here, then we move the $@.1st.make file
3348
1925
#	over to $@ because the .dvi file has already been built by the first
3349
1926
#	dependency run and is valid.
3350
1927
#
3351
1928
#	If we do, we delete that cookie file and do the normal multiple-runs
3352
1929
#	routine.
3353
1930
#
3354
1931
.SECONDARY: $(all_dvi_targets)
3355
1932
%.dvi: %.bbl %.aux
3356
1933
	$(QUIET)\
3357
1934
	fatal=`$(call colorize-latex-errors,$*.log)`; \
3358
1935
	if [ x"$$fatal" != x"" ]; then \
3359
1936
		$(ECHO) "$$fatal"; \
3360
1937
		exit 1; \
3361
1938
	fi; \
3362
1939
	$(call make-auxdvi-file,$*.aux.make,$*.auxdvi.cookie); \
3363
1940
	run=0; \
3364
1941
	for i in 1; do \
3365
1942
		if $(call test-exists,$*.bbl.cookie); then \
3366
1943
			run=1; \
3367
1944
			break; \
3368
1945
		fi; \
3369
1946
		if $(call test-exists,$*.run.cookie); then \
3370
1947
			run=1; \
3371
1948
		    	break; \
3372
1949
		fi; \
3373
1950
		if $(call \
3374
1951
		test-exists-and-different,$*.auxdvi.cookie,$*.auxdvi.make);\
3375
1952
		then \
3376
1953
			run=1; \
3377
1954
			break; \
3378
1955
		fi; \
3379
1956
		if $(call test-log-for-need-to-run,$*); then \
3380
1957
			run=1; \
3381
1958
			break; \
3382
1959
		fi; \
3383
1960
	done; \
3384
1961
	$(call remove-temporary-files,$*.bbl.cookie $*.run.cookie); \
3385
1962
	$(MV) $*.auxdvi.cookie $*.auxdvi.make; \
3386
1963
	if [ x"$$run" = x"1" ]; then \
3387
1964
		$(call remove-files,$@.1st.make); \
3388
1965
		for i in 2 3 4 5; do \
3389
1966
			$(if $(findstring 3.79,$(MAKE_VERSION)),\
3390
1967
				$(call echo-build,$*.tex,$@,$$$$i),\
3391
1968
				$(call echo-build,$*.tex,$@,$$i)\
3392
1969
			); \
3393
1970
			$(call run-latex,$*); \
3394
1971
			$(CP) '$*.log' '$*.'$$i'.log'; \
3395
1972
			$(call test-run-again,$*) || break; \
3396
1973
		done; \
3397
1974
	else \
3398
1975
		$(MV) $@.1st.make $@; \
3399
1976
	fi; \
3400
1977
	$(call copy-with-logging,$@,$(BINARY_TARGET_DIR)); \
3401
1978
	$(call latex-color-log,$*)
3402
1979
3403
1980
# Build the .bbl file.  When dependencies are included, this will (or will
3404
1981
# not!) depend on something.bib, which we detect, acting accordingly.  The
3405
1982
# dependency creation also produces the %.auxbbl.make file.  BibTeX is a bit
3406
1983
# finicky about what you call the actual files, but we can rest assured that if
3407
1984
# a .auxbbl.make file exists, then the .aux file does, as well.  The
3408
1985
# .auxbbl.make file is a cookie indicating whether the .bbl needs to be
3409
1986
# rewritten.  It only changes if the .aux file changes in ways relevant to .bbl
3410
1987
# creation.
3411
1988
#
3412
1989
# Note that we do NOT touch the .bbl file if there is no need to
3413
1990
# create/recreate it.  We would like to leave existing files alone if they
3414
1991
# don't need to be changed, thus possibly avoiding a rebuild trigger on the
3415
1992
# .dvi side.
3416
1993
%.bbl: %.auxbbl.make
3417
1994
	$(QUIET)\
3418
1995
	$(if $(filter %.bib,$^),\
3419
1996
		$(call echo-build,$(filter %.bib,$?) $*.aux,$@); \
3420
1997
		$(call run-bibtex,$*); \
3421
1998
		$(TOUCH) $@.cookie; \
3422
1999
	)
3423
2000
3424
2001
# Create the index file - note that we do *not* depend on %.tex here, since
3425
2002
# that unnecessarily restricts the kinds of indices that we can build to those
3426
2003
# with exactly the same stem as the source file.  Things like splitidx create
3427
2004
# idx files with other names.
3428
2005
#
3429
2006
# Therefore, we add the .tex dependency in the sourcestem.d file in the call to
3430
2007
# get index file dependencies from the logs.
3431
2008
%.ind:	%.idx
3432
2009
	$(QUIET)$(call echo-build,$<,$@)
3433
2010
	$(QUIET)$(call run-makeindex,$<,$@,$*.ilg)
3434
2011
3435
2012
# Create the glossary file
3436
2013
%.gls:	%.glo %.tex
3437
2014
	$(QUIET)$(call echo-build,$<,$@)
3438
2015
	$(QUIET)$(call run-makeindex,$<,$@,$*.glg,-s nomencl.ist)
3439
2016
3440
2017
# Create the nomenclature file
3441
2018
%.nls:	%.nlo %.tex
3442
2019
	$(QUIET)$(call echo-build,$<,$@)
3443
2020
	$(QUIET)$(call run-makeindex,$<,$@,$*.nlg,-s nomencl.ist)
3444
2021
3445
2022
# SCRIPTED LaTeX TARGETS
3446
2023
#
3447
2024
.SECONDARY: $(all_tex_targets)
3448
2025
%.tex:	%.tex.sh
3449
2026
	$(QUIET)$(call echo-build,$<,$@)
3450
2027
	$(QUIET)$(SHELL) $< $@
3451
2028
3452
2029
%.tex:	%.rst $(rst_style_file)
3453
2030
	$(QUIET)$(call echo-build,$<,$@)
3454
2031
	$(QUIET)$(call convert-rst,$<,$@)
3455
2032
3456
2033
#
3457
2034
# GRAYSCALE LaTeX TARGETS
3458
2035
#
3459
2036
3460
2037
# Parse %.d to get all of the include files, then run sed to generate new files
3461
2038
# for all of them that depend on _gray.
3462
2039
%._gray_.tex: %.d %.tex
3463
2040
	$(QUIET)$(call echo-build,$^,$@)
3464
2041
	$(QUIET)\
3465
2042
	texstems=`$(SED) \
3466
2043
		 -e 's/[^:]*:[[:space:]]*\(.*\)\.tex[[:space:]]*$$/\\1/p' \
3467
2044
		 -e 'd' \
3468
2045
		 $<`; \
3469
2046
	for f in $$texstems; do \
3470
2047
		$(SED) \
3471
2048
		-e 's/\.eps/._gray_&/' \
3472
2049
		-e 's/\.pstex/._gray_&/' \
3473
2050
		-e 's/\.pstex_t/._gray_&/' \
3474
2051
		-e 's/_include_/&._gray_/g' \
3475
2052
		$$f.tex > $$f._gray_.tex; \
3476
2053
	done;
3477
2054
3478
2055
#
3479
2056
# GRAPHICS TARGETS
3480
2057
#
3481
2058
.PHONY: all-graphics
3482
2059
all-graphics:	$(all_graphics_targets);
3483
2060
3484
2061
.PHONY: all-pstex all-gray-pstex
3485
2062
all-pstex:	$(all_pstex_targets);
3486
2063
all-gray-pstex:	$(all_gray_pstex_targets);
3487
2064
3488
2065
.PHONY: all-dot2tex
3489
2066
all-dot2tex:	$(all_dot2tex_targets);
3490
2067
3491
2068
.PHONY: show-graphics
3492
2069
show-graphics: all-graphics
3493
2070
	$(VIEW_GRAPHICS) $(all_known_graphics)
3494
2071
3495
2072
$(gray_eps_file):
3496
2073
	$(QUIET)$(call echo-build,$^,$@)
3497
2074
	$(QUIET)$(call create-gray-eps-file,$@)
3498
2075
3499
2076
%._gray_.eps:	%.gpi $(gpi_sed)
3500
2077
	$(QUIET)$(call echo-graphic,$^,$@)
3501
2078
	$(QUIET)$(call convert-gpi,$<,$@,1)
3502
2079
3503
2080
%._gray_.eps:	%.fig
3504
2081
	$(QUIET)$(call echo-graphic,$^,$@)
3505
2082
	$(QUIET)$(call convert-fig,$<,$@,1)
3506
2083
3507
2084
%._gray_.eps: %.dot $(gray_eps_file)
3508
2085
	$(QUIET)$(call echo-graphic,$^,$@)
3509
2086
	$(QUIET)$(call convert-dot,$<,$@,$<.log,1)
3510
2087
3511
2088
%._gray_.eps: %.xvg $(gray_eps_file)
3512
2089
	$(QUIET)$(call echo-graphic,$^,$@)
3513
2090
	$(QUIET)$(call convert-xvg,$<,$@,1)
3514
2091
3515
2092
%._gray_.eps: %.svg $(gray_eps_file)
3516
2093
	$(QUIET)$(call echo-graphic,$^,$@)
3517
2094
	$(QUIET)$(call convert-svg,$<,$@,1)
3518
2095
3519
2096
%._gray_.eps: %.jpg $(gray_jpg_file)
3520
2097
	$(QUIET)$(call echo-graphic,$^,$@)
3521
2098
	$(QUIET)$(call convert-jpg,$<,$@,1)
3522
2099
3523
2100
%._gray_.eps: %.png $(gray_eps_file)
3524
2101
	$(QUIET)$(call echo-graphic,$^,$@)
3525
2102
	$(QUIET)$(call convert-png,$<,$@,1)
3526
2103
3527
2104
%._gray_.eps: %.eps.gz $(gray_eps_file)
3528
2105
	$(QUIET)$(call echo-graphic,$^,$@)
3529
2106
	$(QUIET)$(call convert-epsgz,$<,$@,1)
3530
2107
3531
2108
%._gray_.eps: %.eps $(gray_eps_file)
3532
2109
	$(QUIET)$(call echo-graphic,$^,$@)
3533
2110
	$(QUIET)$(call convert-eps,$<,$@,1)
3534
2111
3535
2112
%._gray_.pstex: %.fig
3536
2113
	$(QUIET)$(call echo-graphic,$^,$@)
3537
2114
	$(QUIET)$(call convert-fig-pstex,$<,$@,1)
3538
2115
3539
2116
%._gray_.pstex_t: %.fig %._gray_.pstex
3540
2117
	$(QUIET)$(call echo-graphic,$^,$@)
3541
2118
	$(QUIET)$(call convert-fig-pstex-t,$<,$@,$*._gray_.pstex,1)
3542
2119
3543
2120
%.eps:	%.gpi $(gpi_sed)
3544
2121
	$(QUIET)$(call echo-graphic,$^,$@)
3545
2122
	$(QUIET)$(call convert-gpi,$<,$@,$(GRAY))
3546
2123
3547
2124
%.eps: %.fig
3548
2125
	$(QUIET)$(call echo-graphic,$^,$@)
3549
2126
	$(QUIET)$(call convert-fig,$<,$@,$(GRAY))
3550
2127
3551
2128
%.eps: %.dot $(if $(GRAY),$(gray_eps_file))
3552
2129
	$(QUIET)$(call echo-graphic,$^,$@)
3553
2130
	$(QUIET)$(call convert-dot,$<,$@,$<.log,$(GRAY))
3554
2131
3555
2132
%.eps: %.xvg $(if $(GRAY),$(gray_eps_file))
3556
2133
	$(QUIET)$(call echo-graphic,$^,$@)
3557
2134
	$(QUIET)$(call convert-xvg,$<,$@,$(GRAY))
3558
2135
3559
2136
%.eps: %.svg $(if $(GRAY),$(gray_eps_file))
3560
2137
	$(QUIET)$(call echo-graphic,$^,$@)
3561
2138
	$(QUIET)$(call convert-svg,$<,$@,$(GRAY))
3562
2139
3563
2140
%.eps: %.jpg $(if $(GRAY),$(gray_eps_file))
3564
2141
	$(QUIET)$(call echo-graphic,$^,$@)
3565
2142
	$(QUIET)$(call convert-jpg,$<,$@,$(GRAY))
3566
2143
3567
2144
%.eps: %.png $(if $(GRAY),$(gray_eps_file))
3568
2145
	$(QUIET)$(call echo-graphic,$^,$@)
3569
2146
	$(QUIET)$(call convert-png,$<,$@,$(GRAY))
3570
2147
3571
2148
%.eps: %.eps.gz $(if $(GRAY),$(gray_eps_file))
3572
2149
	$(QUIET)$(call echo-graphic,$^,$@)
3573
2150
	$(QUIET)$(call convert-epsgz,$<,$@,$(GRAY))
3574
2151
3575
2152
%.pstex: %.fig
3576
2153
	$(QUIET)$(call echo-graphic,$^,$@)
3577
2154
	$(QUIET)$(call convert-fig-pstex,$<,$@,$(GRAY))
3578
2155
3579
2156
%.pstex_t: %.fig %.pstex
3580
2157
	$(QUIET)$(call echo-graphic,$^,$@)
3581
2158
	$(QUIET)$(call convert-fig-pstex-t,$<,$@,$*.pstex,$(GRAY))
3582
2159
3583
2160
%.dot_t: %.dot
3584
2161
	$(QUIET)$(call echo-graphic,$^,$@)
3585
2162
	$(QUIET)$(call convert-dot-tex,$<,$@)
3586
2163
3587
2164
#
3588
2165
# DEPENDENCY-RELATED TARGETS.
3589
2166
#
3590
2167
3591
2168
# Generate all of the information needed to get dependencies
3592
2169
# As a side effect, this creates a .dvi file.  We need to be sure to remove it
3593
2170
# if there are errors.  Errors can take several forms and all of them are found
3594
2171
# within the log file:
3595
2172
#	* There was a LaTeX error
3596
2173
#	* A needed file was not found
3597
2174
#	* Cross references need adjustment
3598
2175
#
3599
2176
# Behavior:
3600
2177
#	This rule is responsible for generating the following:
3601
2178
#	%.aux
3602
2179
#	%.d
3603
2180
#	%.aux.make
3604
2181
#	%.dvi.1st.make (the .dvi file, moved)
3605
2182
#
3606
2183
#	Steps:
3607
2184
#
3608
2185
#	Run latex
3609
2186
#	Move .dvi somewhere else (make no judgements about success)
3610
2187
#	Flatten the .aux file into another file
3611
2188
#	Add source dependencies
3612
2189
#	Add graphic dependencies
3613
2190
#	Add bib dependencies
3614
2191
#
3615
2192
#	Create cookies for various suffixes that may represent files that
3616
2193
#	need to be read by LaTeX in order for it to function properly.
3617
2194
#
3618
2195
%.d %.aux %.aux.make %.fls: %.tex
3619
2196
	$(QUIET)$(call echo-build,$<,$*.d $*.dvi,1)
3620
2197
	$(QUIET)\
3621
2198
	$(call run-latex,$<,--recorder) || $(sh_true); \
3622
2199
	$(CP) '$*.log' '$*.1.log'; \
3623
2200
	$(call die-on-pstexs,$*.log); \
3624
2201
	$(call die-on-dot2tex,$*.log); \
3625
2202
	$(MV) $*.dvi $*.dvi.1st.make; \
3626
2203
	$(call flatten-aux,$*.aux,$*.aux.make); \
3627
2204
	$(ECHO) "# vim: ft=make" > $*.d; \
3628
2205
	$(ECHO) ".PHONY: $*._graphics" >> $*.d; \
3629
2206
	$(call get-inputs,$*.fls,$(addprefix $*.,aux aux.make d dvi)) >> $*.d; \
3630
2207
	$(call get-graphics,$*.log,$(addprefix $*.,d dvi _graphics)) >> $*.d; \
3631
2208
	$(call get-log-index,$*,$(addprefix $*.,d aux aux.make)) >> $*.d; \
3632
2209
	$(call get-bibs,$*.aux.make,$(addprefix $*.,bbl aux aux.make)) >> $*.d; \
3633
2210
	for s in toc out lot lof lol nav; do \
3634
2211
		if [ -e "$*.$$s" ]; then \
3635
2212
			if ! $(DIFF) -q $*.$$s $*.$$s.make 2>/dev/null; then \
3636
2213
				$(TOUCH) $*.run.cookie; \
3637
2214
			fi; \
3638
2215
			$(CP) $*.$$s $*.$$s.make; \
3639
2216
		fi; \
3640
2217
	done
3641
2218
3642
2219
# This is a cookie that is updated if the flattened aux file has changed in a
3643
2220
# way that affects the bibliography generation.
3644
2221
.SECONDARY: $(addsuffix .auxbbl.make,$(stems_ssg))
3645
2222
%.auxbbl.make: %.aux.make
3646
2223
	$(QUIET)\
3647
2224
	$(call make-auxbbl-file,$<,$@.temp); \
3648
2225
	$(call replace-if-different-and-remove,$@.temp,$@)
3649
2226
3650
2227
# Build a dependency file for .gpi files.  These often plot data files that
3651
2228
# also reside in the directory, so if a data file changes, it's nice to know
3652
2229
# about it.  This also handles loaded .gpi files, whose filename should have
3653
2230
# _include_. in it.
3654
2231
%._gray_.gpi.d: %.gpi
3655
2232
	$(QUIET)$(call echo-build,$<,$@)
3656
2233
	$(QUIET)$(call make-gpi-d,$<,$@)
3657
2234
3658
2235
%.gpi.d: %.gpi
3659
2236
	$(QUIET)$(call echo-build,$<,$@)
3660
2237
	$(QUIET)$(call make-gpi-d,$<,$@)
3661
2238
3662
2239
# Store the paper size for this document -- note that if beamer is used we set
3663
2240
# it to the special BEAMER paper size.  We only do this, however, if the
3664
2241
# special comment exists, in which case we enlarge the output with psnup.
3665
2242
#
3666
2243
#	The paper size is extracted from a documentclass attribute.
3667
2244
%.paper.make: %.tex
3668
2245
	$(QUIET)$(SED) \
3669
2246
	-e '/\\documentclass/,/}/{' \
3670
2247
	-e '  s/%.*//' \
3671
2248
	-e '  H' \
3672
2249
	-e '  /}/{' \
3673
2250
	-e '    s/.*//' \
3674
2251
	-e '    x' \
3675
2252
	-e '    /\\documentclass/!d' \
3676
2253
	-e '    s/[\n[:space:]]*//g' \
3677
2254
	-e '    s/\([,{[]\)\([[:alnum:]]\{1,\}\)paper\([],}]\)/\1%-\2-%\3/g' \
3678
2255
	-e '    s/\([,{[]\)\(landscape\)\([],}]\)/\1%-\2-%\3/g' \
3679
2256
	-e '    s/^[^%]*%-//' \
3680
2257
	-e '    s/-%[^%]*$$//' \
3681
2258
	-e '    s/-%[^%]%-/ /g' \
3682
2259
	-e '    p' \
3683
2260
	-e '  }' \
3684
2261
	-e '  d' \
3685
2262
	-e '}' \
3686
2263
	-e 'd' \
3687
2264
	$< > $@; \
3688
2265
	$(EGREP) -q '^[^%]*\\documentclass[^{]*{beamer}' $< && \
3689
2266
	(\
3690
2267
		$(EGREP) -q '^%%[[:space:]]*BEAMER[[:space:]]*LARGE$$' $< && \
3691
2268
		$(ECHO) "BEAMER" > $@ || \
3692
2269
		: > $@ \
3693
2270
	) || $(sh_true)
3694
2271
3695
2272
# Store embedding instructions for this document using a special comment
3696
2273
%.embed.make: %.tex
3697
2274
	$(QUIET)$(EGREP) '^%%[[:space:]]*NO[[:space:]]*EMBED[[:space:]]*$$' $< \
3698
2275
		&& $(ECHO) '' > $@ \
3699
2276
		|| $(ECHO) '1' > $@;
3700
2277
3701
2278
#
3702
2279
# HELPFUL PHONY TARGETS
3703
2280
#
3704
2281
3705
2282
.PHONY: _all_programs
3706
2283
_all_programs:
3707
2284
	$(QUIET)$(ECHO) "== All External Programs Used =="
3708
2285
	$(QUIET)$(call output-all-programs)
3709
2286
3710
2287
.PHONY: _check_programs
3711
2288
_check_programs:
3712
2289
	$(QUIET)$(ECHO) "== Checking Makefile Dependencies =="; $(ECHO)
3713
2290
	$(QUIET) \
3714
2291
	$(ECHO) hi; \
3715
2292
	allprogs=`\
3716
2293
	 ($(call output-all-programs)) | \
3717
2294
	 $(SED) \
3718
2295
	 -e 's/^[[:space:]]*//' \
3719
2296
	 -e '/^#/d' \
3720
2297
	 -e 's/[[:space:]]*#.*//' \
3721
2298
	 -e '/^=/s/[[:space:]]/_/g' \
3722
2299
	 -e '/^[[:space:]]*$$/d' \
3723
2300
	 -e 's/^[^=].*=[[:space:]]*\([^[:space:]]\{1,\}\).*$$/\\1/' \
3724
2301
	 `; \
3725
2302
	spaces='                             '; \
3726
2303
	for p in $${allprogs}; do \
3727
2304
	case $$p in \
3728
2305
		=*) $(ECHO); $(ECHO) "$$p";; \
3729
2306
		*) \
3730
2307
			$(ECHO) -n "$$p:$$spaces" | $(SED) -e 's/^\(.\{0,20\}\).*$$/\1/'; \
3731
2308
			loc=`$(WHICH) $$p`; \
3732
2309
			if [ x"$$?" = x"0" ]; then \
3733
2310
				$(ECHO) "$(C_SUCCESS)Found:$(C_RESET) $$loc"; \
3734
2311
			else \
3735
2312
				$(ECHO) "$(C_FAILURE)Not Found$(C_RESET)"; \
3736
2313
			fi; \
3737
2314
			;; \
3738
2315
	esac; \
3739
2316
	done
3740
2317
3741
2318
.PHONY: _check_gpi_files
3742
2319
_check_gpi_files:
3743
2320
	$(QUIET)$(ECHO) "== Checking all .gpi files for common errors =="; \
3744
2321
	$(ECHO); \
3745
2322
	for f in $(files.gpi); do \
3746
2323
	result=`$(EGREP) '^([^#]*set terminal |set output )' $$f`; \
3747
2324
	$(ECHO) -n "$$f: "; \
3748
2325
	if [ x"$$result" = x"" ]; then \
3749
2326
		$(ECHO) "$(C_SUCCESS)Okay$(C_RESET)"; \
3750
2327
	else \
3751
2328
		$(ECHO) "$(C_FAILURE)Warning: Problematic commands:$(C_RESET)";\
3752
2329
		$(ECHO) "$(C_ERROR)$$result$(C_RESET)"; \
3753
2330
	fi; \
3754
2331
	done; \
3755
2332
	$(ECHO)
3756
2333
3757
2334
.PHONY: _all_stems
3758
2335
_all_stems:
3759
2336
	$(QUIET)$(ECHO) "== All Stems =="
3760
2337
	$(QUIET)$(call echo-list,$(sort $(all_stems)))
3761
2338
3762
2339
.PHONY: _includes
3763
2340
_includes:
3764
2341
	$(QUIET)$(ECHO) "== Include Stems =="
3765
2342
	$(QUIET)$(ECHO) "=== Sources ==="
3766
2343
	$(QUIET)$(call echo-list,$(sort $(source_includes)))
3767
2344
	$(QUIET)$(ECHO) "=== Graphics ==="
3768
2345
	$(QUIET)$(call echo-list,$(sort $(graphic_includes)))
3769
2346
3770
2347
.PHONY: _all_sources
3771
2348
_all_sources:
3772
2349
	$(QUIET)$(ECHO) "== All Sources =="
3773
2350
	$(QUIET)$(call echo-list,$(sort $(all_files.tex)))
3774
2351
3775
2352
.PHONY: _dependency_graph
3776
2353
_dependency_graph:
3777
2354
	$(QUIET)$(ECHO) "/* LaTeX Dependency Graph */"
3778
2355
	$(QUIET)$(call output-dependency-graph)
3779
2356
3780
2357
.PHONY: _show_dependency_graph
3781
2358
_show_dependency_graph:
3782
2359
	$(QUIET)$(call output-dependency-graph,$(graph_stem).dot)
3783
2360
	$(QUIET)$(DOT) -Tps -o $(graph_stem).eps $(graph_stem).dot
3784
2361
	$(QUIET)$(VIEW_POSTSCRIPT) $(graph_stem).eps
3785
2362
	$(QUIET)$(call remove-temporary-files,$(graph_stem).*)
3786
2363
3787
2364
.PHONY: _sources
3788
2365
_sources:
3789
2366
	$(QUIET)$(ECHO) "== Sources =="
3790
2367
	$(QUIET)$(call echo-list,$(sort $(files.tex)))
3791
2368
3792
2369
.PHONY: _scripts
3793
2370
_scripts:
3794
2371
	$(QUIET)$(ECHO) "== Scripts =="
3795
2372
	$(QUIET)$(call echo-list,$(sort $(files_scripts)))
3796
2373
3797
2374
.PHONY: _graphic_outputs
3798
2375
_graphic_outputs:
3799
2376
	$(QUIET)$(ECHO) "== Graphic Outputs =="
3800
2377
	$(QUIET)$(call echo-list,$(sort $(all_graphics_targets)))
3801
2378
3802
2379
.PHONY: _graphic_sources
3803
2380
_graphic_sources:
3804
2381
	$(QUIET)$(ECHO) "== Graphic Sources =="
3805
2382
	$(QUIET)$(call echo-list,$(sort $(files_graphics)))
3806
2383
3807
2384
.PHONY: _env
3808
2385
_env:
3809
2386
ifdef .VARIABLES
3810
2387
	$(QUIET)$(ECHO) "== MAKE VARIABLES =="
3811
2388
	$(QUIET)$(call echo-list,$(foreach var,$(sort $(.VARIABLES)),'$(var)'))
3812
2389
endif
3813
2390
	$(QUIET)$(ECHO) "== ENVIRONMENT =="
3814
2391
	$(QUIET)$(ENV)
3815
2392
3816
2393
#
3817
2394
# CLEAN TARGETS
3818
2395
#
3819
2396
# clean-generated is somewhat unique - it relies on the .fls file being
3820
2397
# properly built so that it can determine which of the files was generated, and
3821
2398
# which was not.  Expect it to silently fail if the .fls file is missing.
3822
2399
#
3823
2400
# This is used to, e.g., clean up index files that are generated by the LaTeX.
3824
2401
.PHONY: clean-generated
3825
2402
clean-generated:
3826
2403
	$(QUIET)$(call clean-files,$(foreach e,$(addsuffix .fls,$(all_stems_source)),\
3827
2404
						$(shell $(call get-generated-names,$e))))
3828
2405
3829
2406
.PHONY: clean-deps
3830
2407
clean-deps:
3831
2408
	$(QUIET)$(call clean-files,$(all_d_targets) *.make *.make.temp *.cookie)
3832
2409
3833
2410
.PHONY: clean-tex
3834
2411
clean-tex: clean-deps
3835
2412
	$(QUIET)$(call clean-files,$(rm_tex))
3836
2413
3837
2414
.PHONY: clean-graphics
3838
2415
# TODO: This *always* deletes pstex files, even if they were not generated by
3839
2416
# anything....  In other words, if you create a pstex and pstex_t pair by hand
3840
2417
# an drop them in here without the generating fig file, they will be deleted
3841
2418
# and you won't get them back.  It's a hack put in here because I'm not sure we
3842
2419
# even want to keep pstex functionality, so my motivation is not terribly high
3843
2420
# for doing it right.
3844
2421
clean-graphics:
3845
2422
	$(QUIET)$(call clean-files,$(all_graphics_targets) *.gpi.d *.pstex *.pstex_t *.dot_t)
3846
2423
3847
2424
.PHONY: clean-backups
3848
2425
clean-backups:
3849
2426
	$(QUIET)$(call clean-files,$(backup_patterns) *.temp)
3850
2427
3851
2428
.PHONY: clean-auxiliary
3852
2429
clean-auxiliary:
3853
2430
	$(QUIET)$(call clean-files,$(graph_stem).*)
3854
2431
3855
2432
.PHONY: clean-nographics
3856
2433
clean-nographics: clean-tex clean-deps clean-backups clean-auxiliary ;
3857
2434
3858
2435
.PHONY: clean
3859
2436
clean:	clean-generated clean-tex clean-graphics clean-deps clean-backups clean-auxiliary
3860
2437
3861
2438
#
3862
2439
# HELP TARGETS
3863
2440
#
3864
2441
3865
2442
.PHONY: help
3866
2443
help:
3867
2444
	$(help_text)
3868
2445
3869
2446
.PHONY: version
3870
2447
version:
3871
2448
	$(QUIET)\
3872
2449
	$(ECHO) "$(fileinfo) Version $(version)"; \
3873
2450
	$(ECHO) "by $(author)"; \
3874
2451
3875
2452
#
3876
2453
# HELP TEXT
3877
2454
#
3878
2455
3879
2456
define help_text
3880
2457
# $(fileinfo) Version $(version)
3881
2458
#
3882
2459
# by $(author)
3883
2460
#
3884
2461
# Generates a number of possible output files from a LaTeX document and its
3885
2462
# various dependencies.  Handles .bib files, \include and \input, and .eps
3886
2463
# graphics.  All dependencies are handled automatically by running LaTeX over
3887
2464
# the source.
3888
2465
#
3889
2466
# USAGE:
3890
2467
#
3891
2468
#    make [GRAY=1] [VERBOSE=1] [SHELL_DEBUG=1] <target(s)>
3892
2469
#
3893
2470
# STANDARD OPTIONS:
3894
2471
#    GRAY:
3895
2472
#        Setting this variable forces all recompiled graphics to be grayscale.
3896
2473
#        It is useful when creating a document for printing.  The default is
3897
2474
#        to allow colors.  Note that it only changes graphics that need to be
3898
2475
#        rebuilt!  It is usually a good idea to do a 'make clean' first.
3899
2476
#
3900
2477
#        There is another facility for creating grayscale documents that is
3901
2478
#        better when you can use it (it has some small limitations not shared
3902
2479
#        by this approach).  See the section on %._gray_ targets below.
3903
2480
#
3904
2481
#    VERBOSE:
3905
2482
#        This turns off all @ prefixes for commands invoked by make.  Thus,
3906
2483
#        you get to see all of the gory details of what is going on.
3907
2484
#
3908
2485
#    SHELL_DEBUG:
3909
2486
#        This enables the -x option for sh, meaning that everything it does is
3910
2487
#        echoed to stderr.  This is particularly useful for debugging
3911
2488
#        what is going on in $$(shell ...) invocations.  One of my favorite
3912
2489
#        debugging tricks is to do this:
3913
2490
#
3914
2491
#        make -d SHELL_DEBUG=1 VERBOSE=1 2>&1 | less
3915
2492
#
3916
2493
# STANDARD AUXILIARY FILES:
3917
2494
#
3918
2495
#      Makefile.ini
3919
2496
#
3920
2497
#          This file can contain variable declarations that override various
3921
2498
#          aspects of the makefile.  For example, one might specify
3922
2499
#
3923
2500
#          neverclean := *.pdf *.ps
3924
2501
#          onlysources.tex := main.tex
3925
2502
#          LATEX_COLOR_WARNING := 'bold red uline'
3926
2503
#
3927
2504
#          And this would override the neverclean setting to ensure that pdf
3928
2505
#          and ps files always remain behind, set the makefile to treat all
3929
2506
#          .tex files that are not "main.tex" as includes (and therefore not
3930
2507
#          default targets).  It also changes the LaTeX warning output to be
3931
2508
#          red, bold, and underlined.
3932
2509
#
3933
2510
#          There are numerous variables in this file that can be overridden in
3934
2511
#          this way.  Search for '?=' to find them all.
3935
2512
#
3936
2513
#          Also, you can put arbitrary targets into it if, for example, you
3937
2514
#          want your source built from something else, e.g.:
3938
2515
#
3939
2516
#          generated.tex: generating_script.weird_lang depA depB
3940
2517
#          	./generating_script.weird_lang > $$@
3941
2518
#
3942
2519
#          The Makefile.ini is imported before anything else is done, so go
3943
2520
#          wild with your ideas for changes to this makefile in there.  It
3944
2521
#          makes it easy to test them before submitting patches.
3945
2522
#
3946
2523
# STANDARD ENVIRONMENT VARIABLES:
3947
2524
#
3948
2525
#      LATEX_COLOR_WARNING		'$(LATEX_COLOR_WARNING)'
3949
2526
#      LATEX_COLOR_ERROR		'$(LATEX_COLOR_ERROR)'
3950
2527
#      LATEX_COLOR_UNDERFULL		'$(LATEX_COLOR_UNDERFULL)'
3951
2528
#      LATEX_COLOR_OVERFULL		'$(LATEX_COLOR_OVERFULL)'
3952
2529
#      LATEX_COLOR_PAGES		'$(LATEX_COLOR_PAGES)'
3953
2530
#      LATEX_COLOR_BUILD		'$(LATEX_COLOR_BUILD)'
3954
2531
#      LATEX_COLOR_GRAPHIC		'$(LATEX_COLOR_GRAPHIC)'
3955
2532
#      LATEX_COLOR_DEP			'$(LATEX_COLOR_DEP)'
3956
2533
#      LATEX_COLOR_SUCCESS		'$(LATEX_COLOR_SUCCESS)'
3957
2534
#      LATEX_COLOR_FAILURE		'$(LATEX_COLOR_FAILURE)'
3958
2535
#
3959
2536
#   These may be redefined in your environment to be any of the following:
3960
2537
#
3961
2538
#      black
3962
2539
#      red
3963
2540
#      green
3964
2541
#      yellow
3965
2542
#      blue
3966
2543
#      magenta
3967
2544
#      cyan
3968
2545
#      white
3969
2546
#
3970
2547
#   Bold or underline may be used, as well, either alone or in combination
3971
2548
#   with colors:
3972
2549
#
3973
2550
#      bold
3974
2551
#      uline
3975
2552
#
3976
2553
#   Order is not important.  You may want, for example, to specify:
3977
2554
#
3978
2555
#   export LATEX_COLOR_SUCCESS='bold blue uline'
3979
2556
#
3980
2557
#   in your .bashrc file.  I don't know why, but you may want to.
3981
2558
#
3982
2559
# STANDARD TARGETS:
3983
2560
# 
3984
2561
#    all:
3985
2562
#        Make all possible documents in this directory.  The documents are
3986
2563
#        determined by scanning for .tex and .tex.sh (described in more detail
3987
2564
#        later) and omitting any file that ends in ._include_.tex or
3988
2565
#        ._nobuild_.tex.  The output is a set of .pdf files.
3989
2566
#
3990
2567
#        If you wish to omit files without naming them with the special
3991
2568
#        underscore names, set the following near the top of the Makefile,
3992
2569
#        or (this is recommended) within a Makefile.ini in the same directory:
3993
2570
#
3994
2571
#        	includes.tex := file1.tex file2.tex
3995
2572
#
3996
2573
#        This will cause the files listed to be considered as include files.
3997
2574
#
3998
2575
#        If you have only few source files, you can set
3999
2576
#
4000
2577
#        	onlysources.tex := main.tex
4001
2578
#
4002
2579
#        This will cause only the source files listed to be considered in
4003
2580
#        dependency detection.  All other .tex files will be considered as
4004
2581
#        include files.  Note that these options work for *any* source type,
4005
2582
#        so you could do something similar with includes.gpi, for example.
4006
2583
#        Note that this works for *any valid source* target.  All of the
4007
2584
#        onlysources.* variables are commented out in the shipping version of
4008
2585
#        this file, so it does the right thing when they simply don't exist.
4009
2586
#        The comments are purely documentation.  If you know, for example, that
4010
2587
#        file.mycoolformat is supported by this Makefile, but don't see the
4011
2588
#        "onlysources.mycoolformat" declared in the comments, that doesn't mean
4012
2589
#        you can't use it.  Go ahead and set "onlysources.mycoolformat" and it
4013
2590
#        should do the right thing.
4014
2591
#
4015
2592
#    show:
4016
2593
#        Builds and displays all documents in this directory.  It uses the
4017
2594
#        environment-overridable value of VIEW_PDF (currently $(VIEW_PDF)) to
4018
2595
#        do its work.
4019
2596
#
4020
2597
#    all-graphics:
4021
2598
#        Make all of the graphics in this directory.
4022
2599
#
4023
2600
#    all-pstex:
4024
2601
#        Build all fig files into pstex and pstex_t files.  Gray DOES NOT WORK.
4025
2602
#
4026
2603
#    all-gray-pstex:
4027
2604
#    	 Build all fig files into grayscale pstex and pstex_t files.
4028
2605
#
4029
2606
#    all-dot2tex:
4030
2607
#    	 Build all dot files into tex files.
4031
2608
#
4032
2609
#    show-graphics:
4033
2610
#        Builds and displays all graphics in this directory.  Uses the
4034
2611
#        environment-overridable value of VIEW_GRAPHICS (currently
4035
2612
#        $(VIEW_GRAPHICS)) to do its work.
4036
2613
#
4037
2614
#    clean:
4038
2615
#        Remove ALL generated files, leaving only source intact.
4039
2616
#        This will *always* skip files mentioned in the "neverclean" variable,
4040
2617
#        either in this file or specified in Makefile.ini:
4041
2618
#        
4042
2619
#        	neverclean := *.pdf *.ps
4043
2620
#
4044
2621
#       The neverclean variable works on all "clean" targets below, as well.
4045
2622
#
4046
2623
#    clean-graphics:
4047
2624
#        Remove all generated graphics files.
4048
2625
#
4049
2626
#    clean-backups:
4050
2627
#        Remove all backup files: $(backup_patterns)
4051
2628
#        (XFig and other editors have a nasty habit of leaving them around)
4052
2629
#        Also removes Makefile-generated .temp files
4053
2630
#
4054
2631
#    clean-tex:
4055
2632
#        Remove all files generated from LaTeX invocations except dependency
4056
2633
#        information.  Leaves graphics alone.
4057
2634
#
4058
2635
#    clean-deps:
4059
2636
#        Removes all auto-generated dependency information.
4060
2637
#
4061
2638
#    clean-auxiliary:
4062
2639
#        Removes extra files created by various targets (like the dependency
4063
2640
#        graph output).
4064
2641
#
4065
2642
#    clean-nographics:
4066
2643
#        Cleans everything *except* the graphics files.
4067
2644
#
4068
2645
#    help:
4069
2646
#        This help text.
4070
2647
#
4071
2648
#    version:
4072
2649
#        Version information about this LaTeX makefile.
4073
2650
#
4074
2651
# DEBUG TARGETS:
4075
2652
#
4076
2653
#    _all_programs:
4077
2654
#        A list of the programs used by this makefile.
4078
2655
#
4079
2656
#    _check_programs:
4080
2657
#        Checks your system for the needed software and reports what it finds.
4081
2658
#
4082
2659
#    _check_gpi_files:
4083
2660
#        Checks the .gpi files in the current directory for common errors, such
4084
2661
#        as specification of the terminal or output file inside of the gpi file
4085
2662
#        itself.
4086
2663
#
4087
2664
#    _dependency_graph:
4088
2665
#        Outputs a .dot file to stdout that represents a graph of LaTeX
4089
2666
#        dependencies.  To see it, use the _show_dependency_graph target or
4090
2667
#        direct the output to a file, run dot on it, and view the output, e.g.:
4091
2668
#
4092
2669
#        make _dependency_graph > graph.dot
4093
2670
#        dot -T ps -o graph.eps graph.dot
4094
2671
#        gv graph.eps
4095
2672
#
4096
2673
#    _show_dependency_graph:
4097
2674
#        Makes viewing the graph simple: extracts, builds and displays the
4098
2675
#        dependency graph given in the _dependency_graph target using the value
4099
2676
#        of the environment-overridable VIEW_POSTSCRIPT variable (currently set
4100
2677
#        to $(VIEW_POSTSCRIPT)).  The postscript viewer is used because it
4101
2678
#        makes it easier to zoom in on the graph, a critical ability for
4102
2679
#        something so dense and mysterious.
4103
2680
#
4104
2681
#    _all_sources:
4105
2682
#        List all .tex files in this directory.
4106
2683
#
4107
2684
#    _sources:
4108
2685
#        Print out a list of all compilable sources in this directory.  This is
4109
2686
#        useful for determining what make thinks it will be using as the
4110
2687
#        primary source for 'make all'.
4111
2688
#
4112
2689
#    _scripts:
4113
2690
#        Print out a list of scripts that make knows can be used to generate
4114
2691
#        .tex files (described later).
4115
2692
#
4116
2693
#    _all_stems:
4117
2694
#        Print a list of stems.  These represent bare targets that can be
4118
2695
#        executed.  Listing <stem> as a bare target will produce <stem>.pdf.
4119
2696
#
4120
2697
#    _includes:
4121
2698
#        A list of .d files that would be included in this run if _includes
4122
2699
#        weren't specified.  This target may be used alone or in conjunction
4123
2700
#        with other targets.
4124
2701
#
4125
2702
#    _graphic_sources:
4126
2703
#        A list of all files that can create .eps files
4127
2704
#
4128
2705
#    _graphic_outputs:
4129
2706
#        A list of all generated .eps files
4130
2707
#
4131
2708
#    _env:
4132
2709
#        A list of environment variables and their values.  If supported by
4133
2710
#        your version of make, also a list of variables known to make.
4134
2711
#
4135
2712
# FILE TARGETS:
4136
2713
#
4137
2714
#    %, %.pdf:
4138
2715
#        Build a PDF file from the corresponding %.tex file.  This is
4139
2716
#        done using dvips and ps2pdf.  Some may object to this idea,
4140
2717
#        saying that pdflatex is a better approach, but I disagree for
4141
2718
#        two major reasons:
4142
2719
#
4143
2720
#        * Postscript can be a very nice thing to have directly from the LaTeX
4144
2721
#          file, especially when printing.
4145
2722
#
4146
2723
#        * One word: psfrag.  If you don't know this wonderful package, get to
4147
2724
#          know it.  It is a workhorse for making graphs pretty.
4148
2725
#
4149
2726
#    %._show:
4150
2727
#        A phony target that builds the pdf file and then displays it using the
4151
2728
#        environment-overridable value of VIEW_PDF ($(VIEW_PDF)).
4152
2729
#
4153
2730
#    %._graphics:
4154
2731
#        A phony target that generates all graphics on which %.dvi
4155
2732
#        depends.
4156
2733
#
4157
2734
#    %.ps:
4158
2735
#        Build a Postscript file from the corresponding %.tex file.
4159
2736
#        This is done using dvips.  Paper size is automatically
4160
2737
#        extracted from the declaration
4161
2738
#
4162
2739
#        \documentclass[<something>paper]
4163
2740
#
4164
2741
#        or it is the system default.
4165
2742
#
4166
2743
#        If using beamer (an excellent presentation class), the paper
4167
2744
#        size is ignored.  More on this later.
4168
2745
#
4169
2746
#    %.dvi:
4170
2747
#        Build the DVI file from the corresponding %.tex file.
4171
2748
#
4172
2749
#    %.ind:
4173
2750
#        Build the index for this %.tex file.
4174
2751
#
4175
2752
#    %.gls:
4176
2753
#        Build the nomenclature glossary for this %.tex file.
4177
2754
#
4178
2755
#    %.nls:
4179
2756
#        Build the (newer) nomenclature file for this %.tex file.
4180
2757
#
4181
2758
#    %.eps:
4182
2759
#        Build an eps file from one of the following file types:
4183
2760
#
4184
2761
#       .dot    : graphviz
4185
2762
#       .gpi    : gnuplot
4186
2763
#       .fig    : xfig
4187
2764
#       .xvg    : xmgrace
4188
2765
#       .svg    : scalable vector graphics (goes through inkscape)
4189
2766
#       .png    : png (goes through NetPBM)
4190
2767
#       .jpg	: jpeg (goes through ImageMagick)
4191
2768
#       .eps.gz : gzipped eps
4192
2769
#
4193
2770
#       The behavior of this makefile with each type is described in
4194
2771
#       its own section below.
4195
2772
#
4196
2773
#    %.pstex{,_t}:
4197
2774
#       Build a .pstex_t file from a .fig file.
4198
2775
#
4199
2776
#    All targets have a corresponding %._gray_.suffix form, which creates
4200
2777
#    everything in monochrome.  This is useful for creating both color and
4201
2778
#    grayscale versions of the same document, and they can coexist happily in
4202
2779
#    the same directory.  Examples:
4203
2780
#
4204
2781
#       make test._gray_._graphics 	# Build all grayscale graphics
4205
2782
#       make test._gray_		# Build a grayscale document
4206
2783
#
4207
2784
#    The use of a ._gray_ target creates ._gray_.tex files (not forgetting the
4208
2785
#    included files!) with appropriate dependencies on ._gray_.eps graphics.
4209
2786
#    This approach is in many ways superior to specifying GRAY=1 on the command
4210
2787
#    line, but has some limitations.  Because a new .tex file must be created,
4211
2788
#    this means that the original .tex file must be parsed and all references
4212
2789
#    to graphics and include files must be transformed.  This can be a brittle
4213
2790
#    operation in a macro-based language like LaTeX, since it is very easy to
4214
2791
#    define macros that call \include or \input indirectly.
4215
2792
#
4216
2793
#    Here the naming strategy for include files comes into play.  They all have
4217
2794
#    ._include_. in their name, and are therefore fairly easy to search out.
4218
2795
#    That sequence is unlikely to appear in text, so it is fairly safe to
4219
2796
#    replace it.  Anything ending in .eps is also replaced to end with
4220
2797
#    ._gray_.eps, and is subject to the same issues.
4221
2798
#
4222
2799
#    In short, if your file contains _include_ when not referencing a file, or
4223
2800
#    it says .eps when not referencing a graphic, this approach is probably not
4224
2801
#    for you.  I imagine that these cases are fairly rare, however, so it
4225
2802
#    should work most of the time.  When a doubt arises, you can be sure that
4226
2803
#    GRAY=1 will do the right thing, provided you precede it with a 'make
4227
2804
#    clean'.
4228
2805
#
4229
2806
# FEATURES:
4230
2807
#
4231
2808
#    Optional Binary Directory:
4232
2809
#        If you create the _out_ directory in the same place as the makefile,
4233
2810
#        it will automatically be used as a dumping ground for .dvi, .ps, and
4234
2811
#        .pdf output files.
4235
2812
#
4236
2813
#        Alternatively, you can set the BINARY_TARGET_DIR variable, either as a
4237
2814
#        make argument or in Makefile.ini, to point to your directory of
4238
2815
#        choice.  Note that no pathname wildcard expansion is done in the
4239
2816
#        makefile, so make sure that the path is complete before going in
4240
2817
#        there.  E.g., if you want to specify something in your home directory,
4241
2818
#        use $$HOME/ instead of ~/ so that the shell expands it before it gets
4242
2819
#        to the makefile.
4243
2820
#
4244
2821
#    External Program Dependencies:
4245
2822
#        Every external program used by the makefile is represented by an
4246
2823
#        ALLCAPS variable at the top of this file.  This should allow you to
4247
2824
#        make judgments about whether your system supports the use of this
4248
2825
#        makefile.  The list is available in the ALL_PROGRAMS variable and,
4249
2826
#        provided that you are using GNU make 3.80 or later (or you haven't
4250
2827
#        renamed this file to something weird like "mylatexmakefile" and like
4251
2828
#        invoking it with make -f) can be viewed using
4252
2829
#
4253
2830
#        make _all_programs
4254
2831
#
4255
2832
#        Additionally, the availability of these programs can be checked
4256
2833
#        automatically for you by running
4257
2834
#
4258
2835
#        make _check_programs
4259
2836
#
4260
2837
#        The programs are categorized according to how important they are and
4261
2838
#        what function they perform to help you decide which ones you really
4262
2839
#        need.
4263
2840
#
4264
2841
#    Colorized Output:
4265
2842
#        The output of commands is colorized to highlight things that are often
4266
2843
#        important to developers.  This includes {underfull,overfull}
4267
2844
#        {h,v}boxes, general LaTeX Errors, each stage of document building, and
4268
2845
#        the number of pages in the final document.  The colors are obtained
4269
2846
#        using 'tput', so colorization should work pretty well on any terminal.
4270
2847
#
4271
2848
#        The colors can be customized very simply by setting any of the
4272
2849
#        LATEX_COLOR_<CONTEXT> variables in your environment (see above).
4273
2850
#
4274
2851
#    Predecessors to TeX Files:
4275
2852
#        Given a target <target>, if no <target>.tex file exists but a
4276
2853
#        corresponding script or predecessor file exists, then appropriate
4277
2854
#        action will be taken to generate the tex file.
4278
2855
#
4279
2856
#        Currently supported script or predecessor languages are:
4280
2857
#
4281
2858
#        sh:     %.tex.sh
4282
2859
#
4283
2860
#           Calls the script using sh, assuming that its output is a .tex
4284
2861
#           file.  Of course, your .sh file can call another script to do
4285
2862
#           its work.  Go wild!
4286
2863
#
4287
2864
#           The script is called thus:
4288
2865
#
4289
2866
#              <interpreter> <script file name> <target tex file>
4290
2867
#
4291
2868
#           and therefore sees exactly one parameter: the name of the .tex
4292
2869
#           file that it is to create.
4293
2870
#
4294
2871
#           Why does this feature exist?  I ran into this while working on
4295
2872
#           my paper dissertation.  I wrote a huge bash script that used a
4296
2873
#           lot of sed to bring together existing papers in LaTeX.  It
4297
2874
#           would have been nice had I had something like this to make my
4298
2875
#           life easier, since as it stands I have to run the script and
4299
2876
#           then build the document with make.  This feature provides hooks
4300
2877
#           for complicated stuff that you may want to do, but that I have
4301
2878
#           not considered.
4302
2879
#
4303
2880
#           This approach does not work for included .tex files.  If you
4304
2881
#           want to do something special with those, you should wrap all of
4305
2882
#           that functionality into a top-level source script that creates
4306
2883
#           the necessary includes as well.
4307
2884
#
4308
2885
#        reST:	 %.rst
4309
2886
#
4310
2887
#           Runs the reST to LaTeX converter to generate a .tex file
4311
2888
#           If it finds a file names _rststyle_._include_.tex, uses it as
4312
2889
#           the "stylesheet" option to rst2latex.
4313
2890
#
4314
2891
#    Dependencies:
4315
2892
#
4316
2893
#        In general, dependencies are extracted directly from LaTeX output on
4317
2894
#        your document.  This includes
4318
2895
#
4319
2896
#        *    Bibliography information
4320
2897
#        *    \include or \input files (honoring \includeonly, too)
4321
2898
#        *    Graphics files inserted by the graphicx package
4322
2899
#
4323
2900
#        Where possible, all of these are built correctly and automatically.
4324
2901
#        In the case of graphics files, these are generated from the following
4325
2902
#        file types:
4326
2903
#
4327
2904
#        GraphViz:      .dot
4328
2905
#        GNUPlot:       .gpi
4329
2906
#        XFig:          .fig
4330
2907
#        XMgrace:       .xvg
4331
2908
#        SVG:           .svg
4332
2909
#        PNG:           .png
4333
2910
#        JPEG:          .jpg
4334
2911
#        GZipped EPS:   .eps.gz
4335
2912
#
4336
2913
#        If the file exists as a .eps already, it is merely used (and will not
4337
2914
#        be deleted by 'clean'!).
4338
2915
#
4339
2916
#        LaTeX and BibTeX are invoked correctly and the "Rerun to get
4340
2917
#        cross-references right" warning is heeded a reasonable number of
4341
2918
#        times.  In my experience this is enough for even the most troublesome
4342
2919
#        documents, but it can be easily changed (if LaTeX has to be run after
4343
2920
#        BibTeX more than three times, it is likely that something is moving
4344
2921
#        back and forth between pages, and no amount of LaTeXing will fix
4345
2922
#        that).
4346
2923
#
4347
2924
#        \includeonly is honored by this system, so files that are not
4348
2925
#        specified there will not trigger a rebuild when changed.
4349
2926
#
4350
2927
#    Beamer:
4351
2928
#        A special TeX source comment is recognized by this makefile:
4352
2929
#
4353
2930
#        %%[[:space:]]*BEAMER[[:space:]]*LARGE
4354
2931
#
4355
2932
#        The presence of this comment forces the output of dvips through psnup
4356
2933
#        to enlarge beamer slides to take up an entire letter-sized page.  This
4357
2934
#        is particularly useful when printing transparencies or paper versions
4358
2935
#        of the slides.  For some reason landscape orientation doesn't appear
4359
2936
#        to work, though.
4360
2937
#
4361
2938
#        If you want to put multiple slides on a page, use this option and then
4362
2939
#        print using mpage, a2ps, or psnup to consolidate slides.  My personal
4363
2940
#        favorite is a2ps, but your mileage may vary.
4364
2941
#
4365
2942
#        When beamer is the document class, dvips does NOT receive a paper size
4366
2943
#        command line attribute, since beamer does special things with sizes.
4367
2944
#
4368
2945
#    GNUPlot Graphics:
4369
2946
#        When creating a .gpi file, DO NOT INCLUDE the "set terminal" or "set
4370
2947
#        output" commands!  The makefile will include terminal information for
4371
2948
#        you.  Besides being unnecessary and potentially harmful, including the
4372
2949
#        terminal definition in the .gpi file makes it harder for you, the one
4373
2950
#        writing the document, to preview your graphics, e.g., with
4374
2951
#
4375
2952
#           gnuplot -persist myfile.gpi
4376
2953
#
4377
2954
#        so don't do specify a terminal or an output file in your .gpi files.
4378
2955
#
4379
2956
#        When building a gpi file into an eps file, there are several features
4380
2957
#        available to the document designer:
4381
2958
#
4382
2959
#        Global Header:
4383
2960
#            The makefile searches for the files in the variable GNUPLOT_GLOBAL
4384
2961
#            in order:
4385
2962
#
4386
2963
#            ($(GNUPLOT_GLOBAL))
4387
2964
#
4388
2965
#            Only the first found is used.  All .gpi files in the directory are
4389
2966
#            treated as though the contents of GNUPLOT_GLOBAL were directly
4390
2967
#            included at the top of the file.
4391
2968
#
4392
2969
#            NOTE: This includes special comments! (see below)
4393
2970
#
4394
2971
#        Font Size:
4395
2972
#            A special comment in a .gpi file (or a globally included file) of
4396
2973
#            the form
4397
2974
#
4398
2975
#            ## FONTSIZE=<number>
4399
2976
#
4400
2977
#            will change the font size of the GPI output.  If font size is
4401
2978
#            specified in both the global file and the GPI file, the
4402
2979
#            specification in the individual GPI file is used.
4403
2980
#
4404
2981
#        Grayscale Output:
4405
2982
#            GNUplot files also support a special comment to force them to be
4406
2983
#            output in grayscale *no matter what*:
4407
2984
#
4408
2985
#            ## GRAY
4409
2986
#
4410
2987
#            This is not generally advisable, since you can always create a
4411
2988
#            grayscale document using the forms mentioned above.  But, if your
4412
2989
#            plot simply must be grayscale even in a document that allows
4413
2990
#            colors, this is how you do it.    
4414
2991
#
4415
2992
#    XFig Graphics:
4416
2993
#            No special handling is done with XFig, except when a global
4417
2994
#            grayscale method is used, e.g.
4418
2995
#
4419
2996
#                make document._gray_
4420
2997
#                or
4421
2998
#                make GRAY=1 document
4422
2999
#
4423
3000
#            In these cases the .eps files is created using the -N switch to
4424
3001
#            fig2dev to turn off color output.  (Only works with eps, not
4425
3002
#            pstex output!)
4426
3003
#
4427
3004
#    GraphVis Graphics:
4428
3005
#            Color settings are simply ignored here.  The 'dot' program is used
4429
3006
#            to transform a .dot file into a .eps file.
4430
3007
#
4431
3008
#            If you want, you can use the dot2tex program to convert dot files
4432
3009
#            to tex graphics.  The default is to just call dot2tex with no
4433
3010
#            arguments, but you can change the DOT2TEX definition to include
4434
3011
#            options as needed (in your Makefile.ini).
4435
3012
#
4436
3013
#            Note that, like pstex, the makefile cannot use latex's own output
4437
3014
#            to discover all missing dot_t (output) files, since anytime TeX
4438
3015
#            includes TeX, it has to bail when it can't find the include file.
4439
3016
#            It can therefore only stop on the first missing file it discovers,
4440
3017
#            and we can't get a large list of them out easily.
4441
3018
#
4442
3019
#            So, the makefile errors out if it's missing an included dot_t
4443
3020
#            file, then prompts the user to run this command manually:
4444
3021
#
4445
3022
#                make all-dot2tex
4446
3023
#
4447
3024
#    GZipped EPS Graphics:
4448
3025
#        
4449
3026
#        A .eps.gz file is sometimes a nice thing to have.  EPS files can get
4450
3027
#        very large, especially when created from bitmaps (don't do this if you
4451
3028
#        don't have to).  This makefile will unzip them (not in place) to
4452
3029
#        create the appropriate EPS file.
4453
3030
#
4454
3031
endef
4455
3032
4456
3033
#
4457
3034
# DEPENDENCY CHART:
4458
3035
#
4459
3036
#digraph "g" {
4460
3037
#    rankdir=TB
4461
3038
#    size="9,9"
4462
3039
#    edge [fontsize=12 weight=10]
4463
3040
#    node [shape=box fontsize=14 style=rounded]
4464
3041
#
4465
3042
#    eps [
4466
3043
#        shape=Mrecord
4467
3044
#        label="{{<gpi> GNUplot|<epsgz> GZip|<dot> Dot|<fig> XFig}|<eps> eps}"
4468
3045
#        ]
4469
3046
#    pstex [label="%.pstex"]
4470
3047
#    pstex_t [label="%.pstex_t"]
4471
3048
#    tex_outputs [shape=point]
4472
3049
#    extra_tex_files [shape=point]
4473
3050
#    gpi_data [label="<data>"]
4474
3051
#    gpi_includes [label="_include_.gpi"]
4475
3052
#    aux [label="%.aux"]
4476
3053
#    fls [label="%.fls"]
4477
3054
#    idx [label="%.idx"]
4478
3055
#    glo [label="%.glo"]
4479
3056
#    ind [label="%.ind"]
4480
3057
#    log [label="%.log"]
4481
3058
#    tex_sh [label="%.tex.sh"]
4482
3059
#    rst [label="%.rst"]
4483
3060
#    tex [
4484
3061
#        shape=record
4485
3062
#        label="<tex> %.tex|<include> _include_.tex"
4486
3063
#        ]
4487
3064
#    include_aux [label="_include_.aux"]
4488
3065
#    file_bib [label=".bib"]
4489
3066
#    bbl [label="%.bbl"]
4490
3067
#    dvi [label="%.dvi"]
4491
3068
#    ps [label="%.ps"]
4492
3069
#    pdf [label="%.pdf"]
4493
3070
#    fig [label=".fig"]
4494
3071
#    dot [label=".dot"]
4495
3072
#    gpi [label=".gpi"]
4496
3073
#    eps_gz [label=".eps.gz"]
4497
3074
#
4498
3075
#    gpi_files [shape=point]
4499
3076
#
4500
3077
#    rst -> tex:tex [label="reST"]
4501
3078
#    tex_sh -> tex:tex [label="sh"]
4502
3079
#    tex -> tex_outputs [label="latex"]
4503
3080
#    tex_outputs -> dvi
4504
3081
#    tex_outputs -> aux
4505
3082
#    tex_outputs -> log
4506
3083
#    tex_outputs -> fls
4507
3084
#    tex_outputs -> idx
4508
3085
#    tex_outputs -> include_aux
4509
3086
#    aux -> bbl [label="bibtex"]
4510
3087
#    file_bib -> bbl [label="bibtex"]
4511
3088
#    idx -> ind [label="makeindex"]
4512
3089
#    glo -> gls [label="makeindex"]
4513
3090
#    nlo -> nls [label="makeindex"]
4514
3091
#    gls -> extra_tex_files
4515
3092
#    nls -> extra_tex_files
4516
3093
#    ind -> extra_tex_files
4517
3094
#    bbl -> extra_tex_files
4518
3095
#    eps -> extra_tex_files
4519
3096
#    extra_tex_files -> dvi [label="latex"]
4520
3097
#    gpi_files -> eps:gpi [label="gnuplot"]
4521
3098
#    gpi -> gpi_files
4522
3099
#    gpi_data -> gpi_files
4523
3100
#    gpi_includes -> gpi_files
4524
3101
#    eps_gz -> eps:epsgz [label="gunzip"]
4525
3102
#    fig -> eps:fig [label="fig2dev"]
4526
3103
#    fig -> pstex [label="fig2dev"]
4527
3104
#    fig -> pstex_t [label="fig2dev"]
4528
3105
#    pstex -> pstex_t [label="fig2dev"]
4529
3106
#    dot -> eps:dot [label="dot"]
4530
3107
#    dvi -> ps [label="dvips"]
4531
3108
#    include_aux -> bbl [label="bibtex"]
4532
3109
#    ps -> pdf [label="ps2pdf"]
4533
3110
#
4534
3111
#    edge [ color=blue label="" style=dotted weight=1 fontcolor=blue]
4535
3112
#    fls -> tex:include [label="INPUT: *.tex"]
4536
3113
#    fls -> file_bib [label="INPUT: *.aux"]
4537
3114
#    aux -> file_bib [label="\\bibdata{...}"]
4538
3115
#    include_aux -> file_bib [label="\\bibdata{...}"]
4539
3116
#    log -> gpi [label="Graphic file"]
4540
3117
#    log -> fig [label="Graphic file"]
4541
3118
#    log -> eps_gz [label="Graphic file"]
4542
3119
#    log -> dot [label="Graphic file"]
4543
3120
#    log -> idx [label="No file *.ind"]
4544
3121
#    log -> glo [label="No file *.gls"]
4545
3122
#    log -> nlo [label="No file *.nls"]
4546
3123
#    gpi -> gpi_data [label="plot '...'"]
4547
3124
#    gpi -> gpi_includes [label="load '...'"]
4548
3125
#    tex:tex -> ps [label="paper"]
4549
3126
#    tex:tex -> pdf [label="embedding"]
4550
3127
#}
4551
3128
4552
3129
#
4553
3130
# DEPENDENCY CHART SCRIPT
4554
3131
#
4555
3132
# $(call output_dependency_graph,[<output file>])
4556
3133
define output-dependency-graph
4557
3134
	if [ -f '$(this_file)' ]; then \
4558
3135
	$(SED) \
4559
3136
		-e '/^[[:space:]]*#[[:space:]]*DEPENDENCY CHART:/,/^$$/!d' \
4560
3137
		-e '/DEPENDENCY CHART/d' \
4561
3138
		-e '/^$$/d' \
4562
3139
		-e 's/^[[:space:]]*#//' \
4563
3140
		$(this_file) $(if $1,> '$1',); \
4564
3141
	else \
4565
3142
		$(ECHO) "Cannot determine the name of this makefile."; \
4566
3143
	fi
4567
3144
endef
4568
3145
# vim: noet sts=0 sw=8 ts=8
4569
3
3146
4570
=== added directory 'Planet Stuff'
4571
=== added file 'Planet Stuff/READ THIS FIRST!!'
4572
--- Planet Stuff/READ THIS FIRST!!	1970-01-01 00:00:00 +0000
4573
+++ Planet Stuff/READ THIS FIRST!!	2014-09-01 04:44:23 +0000
4574
@@ -0,0 +1,5 @@
4575
1
It's mainly all set up, all you have to do is follow these instructions to add feeds and then create a cron job to update it every 15 mins or so.
4576
2
4577
3
https://wiki.ubuntu.com/LoCoCreatingPlanet
4578
4
4579
5
I've downloaded the latest version of planet and extracted here. It's in /planet-2.0
4580
0
6
4581
=== added file 'Planet Stuff/README'
4582
--- Planet Stuff/README	1970-01-01 00:00:00 +0000
4583
+++ Planet Stuff/README	2014-09-01 04:44:23 +0000
4584
@@ -0,0 +1,11 @@
4585
1
This is the planet.ubuntu.ro new PlanetPlanet theme. Code is a modified moinmoin 
4586
2
design, containing also code from ubuntu.com drupal theme.
4587
3
4588
4
You are free to use this theme on other ubuntu planets.
4589
5
4590
6
For instalation, css/, img/ and planet.css must be copied into planetplanet's
4591
7
output directory. The links shall be changed in index.html.tmpl. The logo is
4592
8
in img/ as logo.png
4593
9
4594
10
Any further information available upon request from alexef@softwareliber.ro or
4595
11
alex@eftimie.ro.
4596
0
12
4597
=== added directory 'Planet Stuff/css'
4598
=== added directory 'Planet Stuff/css/.ssh'
4599
=== added file 'Planet Stuff/css/.ssh/authorized_keys'
4600
--- Planet Stuff/css/.ssh/authorized_keys	1970-01-01 00:00:00 +0000
4601
+++ Planet Stuff/css/.ssh/authorized_keys	2014-09-01 04:44:23 +0000
4602
@@ -0,0 +1,2 @@
4603
1
ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAtRP0Iisni0A4mkqLkdxlwEswZb9YOxsAj9eu3vBYu9OWW2CBK/Spz5v0aAVbqOd2f1jG1rC+KMWdA7Dpe0ZvofSM4EXN8mNXChv0awUN0ENURMurKtfq1QxarCz9U+ErDhi1k5CoebszjtuWvR3AntPtTzyISY7f2mwc0PU50kOiayJf4dE1hutvRzTqcSVj00ZMgF5L/G1xIyu+sHPOHcEEC+JA9f91iX4E364AZgv5lp9QUZ7byrlf2MUBnvLI2jxz2BRCtysxR/6Af/2UpwLUEs9bcjPj4ZC36P1tdUvgw2p3lLVGNG0RdkQoGEdwZ9k7AEFVZwJfPl77V+8EcQ== alex@soleares
4604
2
4605
0
3
4606
=== added file 'Planet Stuff/css/bg-page.png'
4607
1
Binary files Planet Stuff/css/bg-page.png	1970-01-01 00:00:00 +0000 and Planet Stuff/css/bg-page.png	2014-09-01 04:44:23 +0000 differ
4
Binary files Planet Stuff/css/bg-page.png	1970-01-01 00:00:00 +0000 and Planet Stuff/css/bg-page.png	2014-09-01 04:44:23 +0000 differ
4608
=== added file 'Planet Stuff/css/bullet-triangle.png'
4609
2
Binary files Planet Stuff/css/bullet-triangle.png	1970-01-01 00:00:00 +0000 and Planet Stuff/css/bullet-triangle.png	2014-09-01 04:44:23 +0000 differ
5
Binary files Planet Stuff/css/bullet-triangle.png	1970-01-01 00:00:00 +0000 and Planet Stuff/css/bullet-triangle.png	2014-09-01 04:44:23 +0000 differ
4610
=== added file 'Planet Stuff/css/common.css'
4611
--- Planet Stuff/css/common.css	1970-01-01 00:00:00 +0000
4612
+++ Planet Stuff/css/common.css	2014-09-01 04:44:23 +0000
4613
@@ -0,0 +1,367 @@
4614
1
/*  common.css - MoinMoin Default Styles
4615
2
Copyright (c) 2001, 2002, 2003 by Juergen Hermann
4616
3
*/
4617
4
4618
5
/* Links */
4619
6
4620
7
a {
4621
8
	color: #D90D19;
4622
9
}
4623
10
4624
11
a:hover {
4625
12
	color: #800000;
4626
13
}
4627
14
4628
15
/* Headings */
4629
16
4630
17
#pagelocation li {
4631
18
	display: inline;
4632
19
}
4633
20
4634
21
#pagelocation {
4635
22
	margin: 0;
4636
23
	padding: 0;
4637
24
	color: #6d4c07; /* ubuntu dark brown */
4638
25
	font-size: 1.8em;
4639
26
	font-weight: bold; 
4640
27
	line-height: 1.2em;
4641
28
	border-bottom: 3px solid #6d4c07; /* ubuntu dark brown */
4642
29
}
4643
30
4644
31
#pagelocation a {
4645
32
	text-decoration: none;    
4646
33
	color: #6d4c07; /* ubuntu dark brown */
4647
34
}
4648
35
4649
36
h1, h2, h3, h4, h5, h6
4650
37
{
4651
38
        margin: 0;
4652
39
        /* AE: conflicts with bubbles padding: 2px 0;*/
4653
40
        font-weight: normal; 
4654
41
        color: #5A3320;
4655
42
        line-height: 1.2em;
4656
43
}	
4657
44
4658
45
h1
4659
46
{
4660
47
	font-size: 1.6em;
4661
48
	border-bottom: 1px solid #6d4c07; /* ubuntu dark brown */
4662
49
}
4663
50
4664
51
h2
4665
52
{
4666
53
	font-size: 1.3em;
4667
54
}
4668
55
4669
56
h3 {font-size: 1.1em;}
4670
57
h4, h5, h6 {font-size: 1em;}
4671
58
4672
59
li p {
4673
60
	margin: .25em 0;
4674
61
}
4675
62
4676
63
li.gap {
4677
64
    margin-top: 0.5em;
4678
65
}
4679
66
4680
67
/* from ubuntu_styles; sizes changed to em */
4681
68
dt
4682
69
{
4683
70
    margin-top: 1.2em;
4684
71
    margin-bottom: 0.3em;
4685
72
    font-size: 1.2em;
4686
73
    border-bottom: 1px solid #6D4C07;
4687
74
}
4688
75
4689
76
dd {
4690
77
    margin-top: 0;
4691
78
    margin-bottom: 0;
4692
79
}
4693
80
4694
81
dd p {
4695
82
    margin: 0.25em 0;
4696
83
}
4697
84
   
4698
85
a, img, img.drawing {
4699
86
	border: 0;
4700
87
}
4701
88
4702
89
pre 
4703
90
{
4704
91
	border: 1px dashed #C1B496; /* ubuntu dark tan */
4705
92
	background-color: #f0eee6; /* ubuntu light salmon */
4706
93
	padding: 4pt;
4707
94
	font-family: courier, monospace;
4708
95
	white-space: pre;
4709
96
	/* begin css 3 or browser specific rules - do not remove!
4710
97
	see: http://forums.techguy.org/archive/index.php/t-249849.html */
4711
98
    white-space: pre-wrap;
4712
99
    word-wrap: break-word;
4713
100
    white-space: -moz-pre-wrap;
4714
101
    white-space: -pre-wrap;
4715
102
    white-space: -o-pre-wrap;
4716
103
    /* end css 3 or browser specific rules */
4717
104
}
4718
105
4719
106
table
4720
107
{
4721
108
	margin: 0.5em 0;
4722
109
	border-collapse: collapse;
4723
110
}
4724
111
4725
112
td
4726
113
{
4727
114
	padding: 0.25em;
4728
115
	border: 1pt solid #C1B496; /* ubuntu dark tan */
4729
116
}
4730
117
4731
118
td p {
4732
119
	margin: 0;
4733
120
	padding: 0;
4734
121
}
4735
122
4736
123
.footnotes div {
4737
124
	width: 5em;
4738
125
	border-top: 1pt solid #C1B496; /* ubuntu dark tan */
4739
126
}
4740
127
4741
128
.footnotes ul {
4742
129
	padding: 0 2em;
4743
130
	margin: 0 0 1em;
4744
131
	list-style: none;
4745
132
}
4746
133
4747
134
.footnotes li {
4748
135
}
4749
136
4750
137
.info {
4751
138
    font-size: 0.85em;
4752
139
    color: #C1B496; /* ubuntu dark tan */
4753
140
}
4754
141
4755
142
#pageinfo {
4756
143
    margin-top: 2em;
4757
144
}
4758
145
4759
146
.seperator {
4760
147
    color: #C1B496; /* ubuntu dark tan */
4761
148
}
4762
149
4763
150
#pagebottom {clear: both;}
4764
151
4765
152
/* standard rule ---- */
4766
153
hr {
4767
154
    height: 1pt;
4768
155
    background-color: #C1B496; /* ubuntu dark tan */
4769
156
    border: 0;
4770
157
}
4771
158
4772
159
/* custom rules ----- to ---------- */
4773
160
.hr1 {height: 2pt;}
4774
161
.hr2 {height: 3pt;}
4775
162
.hr3 {height: 4pt;}
4776
163
.hr4 {height: 5pt;}
4777
164
.hr5 {height: 6pt;}
4778
165
.hr6 {height: 7pt;}
4779
166
4780
167
/* Replacement for html 3 u tag */
4781
168
.u {text-decoration: underline;}
4782
169
4783
170
/* eye catchers */
4784
171
.warning 
4785
172
{
4786
173
	color: red;
4787
174
}
4788
175
4789
176
.error 
4790
177
{
4791
178
	color: red;
4792
179
}
4793
180
4794
181
strong.highlight 
4795
182
{
4796
183
	background-color: #edddba; /* ubuntu pale orange */
4797
184
	padding: 1pt;
4798
185
}
4799
186
4800
187
4801
188
/* Recent changes */
4802
189
4803
190
.rcrss {
4804
191
	float: right;
4805
192
	margin: 0;
4806
193
}
4807
194
4808
195
.recentchanges[dir="rtl"] .rcrss {
4809
196
	float: left;
4810
197
}
4811
198
4812
199
.recentchanges table {
4813
200
	clear: both;
4814
201
}
4815
202
4816
203
.recentchanges td {
4817
204
	vertical-align: top;
4818
205
	border: none;
4819
206
	border-bottom: 1pt solid #C1B496; /* ubuntu dark tan */
4820
207
	background: white;
4821
208
}
4822
209
4823
210
.rcdaybreak td {
4824
211
	background: #EDD097; /* classic: deep yellow */
4825
212
	border: none;
4826
213
}
4827
214
4828
215
.rcdaybreak td a {
4829
216
	font-size: 0.88em;
4830
217
}
4831
218
4832
219
.rcicon1, .rcicon2 {
4833
220
	text-align: center;
4834
221
}
4835
222
4836
223
.rcpagelink {
4837
224
	width: 33%;
4838
225
}
4839
226
4840
227
.rctime {
4841
228
	font-size: 0.88em;
4842
229
	white-space: nowrap;
4843
230
}
4844
231
4845
232
.rceditor {
4846
233
	white-space: nowrap;
4847
234
	font-size: 0.88em;
4848
235
}
4849
236
4850
237
.rccomment {
4851
238
	width: 66%;
4852
239
	color: #C1B496; /* ubuntu dark tan */
4853
240
	font-size: 0.88em;
4854
241
	font-weight: bold;
4855
242
}
4856
243
4857
244
4858
245
/* User Preferences */
4859
246
4860
247
.userpref table, .userpref td {
4861
248
	border: none;
4862
249
}
4863
250
4864
251
/* CSS for new code_area markup used by Colorizer and ParserBase */
4865
252
4866
253
div.codearea { /* the div makes the border */
4867
254
	margin: 4pt 0;
4868
255
	padding: 0;
4869
256
	border: 1pt solid #C1B496; /* ubuntu dark tan */
4870
257
/*	background-color: #F3F5F7;   * light grey */
4871
258
	background-color: #edddba; /* ubuntu pale orange */
4872
259
	color: black;
4873
260
}
4874
261
4875
262
div.codearea pre { /* the pre has no border and is inside the div */
4876
263
	margin: 0;
4877
264
	padding: 4pt;
4878
265
	border: none;
4879
266
}
4880
267
4881
268
a.codenumbers { /* format of the line numbering link */
4882
269
	margin: 0 4pt;
4883
270
	font-size: 0.85em;
4884
271
	color: #6d4c07; /* ubuntu dark brown */
4885
272
}
4886
273
4887
274
/* format of certain syntax spans */
4888
275
div.codearea pre span.LineNumber {color: gray;}
4889
276
div.codearea pre span.ID         {color: #000000;}
4890
277
div.codearea pre span.Operator   {color: #0000C0;}
4891
278
div.codearea pre span.Char       {color: #004080;}
4892
279
div.codearea pre span.Comment    {color: #008000;}
4893
280
div.codearea pre span.Number     {color: #0080C0;}
4894
281
div.codearea pre span.String     {color: #004080;}
4895
282
div.codearea pre span.SPChar     {color: #0000C0;}
4896
283
div.codearea pre span.ResWord    {color: #A00000;}
4897
284
div.codearea pre span.ConsWord   {color: #008080; font-weight: bold;}
4898
285
div.codearea pre span.Error      {color: #FF8080; border: solid 1.5pt #FF0000;}
4899
286
div.codearea pre span.ResWord2   {color: #0080ff; font-weight: bold;}
4900
287
div.codearea pre span.Special    {color: #0000ff;}
4901
288
div.codearea pre span.Preprc     {color: #803999;}
4902
289
4903
290
4904
291
/* Search results */
4905
292
4906
293
.searchresults dt {
4907
294
    margin-top: 1em;
4908
295
	font-weight: normal;
4909
296
}
4910
297
4911
298
.searchresults dd {
4912
299
	font-size: 0.85em;
4913
300
}
4914
301
4915
302
/* MonthCalendar css */
4916
303
4917
304
/* days without and with pages linked to them */
4918
305
a.cal-emptyday {
4919
306
    color: #777777;
4920
307
    text-align: center;
4921
308
}
4922
309
a.cal-usedday {
4923
310
    color: #000000;
4924
311
    font-weight: bold;
4925
312
    text-align: center;
4926
313
}
4927
314
/* general stuff: workdays, weekend, today */
4928
315
td.cal-workday {
4929
316
    background-color: #F1F1ED; /* ubuntu near-white */
4930
317
    text-align: center;
4931
318
}
4932
319
td.cal-weekend {
4933
320
    background-color: #edddba; /* ubuntu pale orange */
4934
321
    text-align: center;
4935
322
}
4936
323
td.cal-today {
4937
324
    background-color: #DBBA75; /* ubuntu orange */
4938
325
    border-style: solid;
4939
326
    border-width: 2pt;
4940
327
    text-align: center;
4941
328
}
4942
329
/* invalid places on the monthly calendar sheet */
4943
330
td.cal-invalidday {
4944
331
    background-color: #CCCCCC;
4945
332
}
4946
333
/* links to prev/next month/year */
4947
334
a.cal-link {
4948
335
    color: #F1F1ED; /* ubuntu near-white */
4949
336
    text-decoration: none;
4950
337
}
4951
338
th.cal-header {
4952
339
    background-color: #6d4c07; /* ubuntu dark brown */
4953
340
    color: white;
4954
341
    text-align: center;
4955
342
}
4956
343
4957
344
/* for MonthCalendar mouseover info boxes */
4958
345
TABLE.tip {
4959
346
    color: black;
4960
347
	border: 1px solid #C1B496; /* ubuntu dark tan */
4961
348
	background-color: #f0eee6; /* ubuntu light salmon */
4962
349
    font-size: small;
4963
350
    font-weight: normal;
4964
351
}
4965
352
4966
353
TH.tip {
4967
354
    background-color: #DBBA75; /* ubuntu orange */
4968
355
    font-weight: bold;
4969
356
    text-align: center;
4970
357
}
4971
358
4972
359
TD.tip {
4973
360
    text-align: left;
4974
361
}
4975
362
*[dir="rtl"] TD.tip {
4976
363
    text-align: right;
4977
364
}
4978
365
4979
366
/* end MonthCalendar stuff */
4980
367
4981
0
368
4982
=== added file 'Planet Stuff/css/screen.css'
4983
--- Planet Stuff/css/screen.css	1970-01-01 00:00:00 +0000
4984
+++ Planet Stuff/css/screen.css	2014-09-01 04:44:23 +0000
4985
@@ -0,0 +1,434 @@
4986
1
/*  screen.css - MoinMoin Default Styles
4987
2
4988
3
Copyright (c) 2001, 2002, 2003 by Juergen Hermann
4989
4
Modified by Nir Soffer (technical theme), Mauricio Hernandez (ruleta theme)
4990
5
Heather Stern (ubuntu theme), Alex Eftimie (planet ubuntu theme)
4991
6
*/
4992
7
4993
8
body {
4994
9
	background: #d3caaa url(bg-page.png) repeat-x top;
4995
10
	margin: 20px;
4996
11
	font-size: 90%;
4997
12
	font-family: Arial, Verdana, Arial, sans-serif;
4998
13
}
4999
14
5000
15
img.ubuntulogo {
Reviewer	Review Type	Date Requested	Status
Jeffrey Flaker			Pending
Review via email: mp+232844@code.launchpad.net