annotate en/99defs.tex @ 103:5b80c922ebdd

More merge content.
author Bryan O'Sullivan <bos@serpentine.com>
date Thu, 19 Oct 2006 15:18:07 -0700
parents ea951cfb5cd9
children 9cbc5d0db542
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
1 % Bug ID.
38
b49a7dd4e564 More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 37
diff changeset
2 \newcommand{\bug}[1]{\index{Mercurial bug
b49a7dd4e564 More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 37
diff changeset
3 database!\href{http://www.selenic.com/mercurial/bts/issue#1}{bug
b49a7dd4e564 More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 37
diff changeset
4 ~#1}}\href{http://www.selenic.com/mercurial/bts/issue#1}{Mercurial
b49a7dd4e564 More content for hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 37
diff changeset
5 bug no.~#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
6
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
7 % File name in the user's home directory.
4
33a2e7b9978d Make it possible to include example input and output from real programs.
Bryan O'Sullivan <bos@serpentine.com>
parents: 3
diff changeset
8 \newcommand{\tildefile}[1]{\texttt{\~{}/#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
9
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
10 % File name.
2
379a802c0210 Add bibliography.
Bryan O'Sullivan <bos@serpentine.com>
parents: 0
diff changeset
11 \newcommand{\filename}[1]{\texttt{#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
12
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
13 % Directory name.
16
81454425eee9 Progress on a few fronts, mainly indexing and MQ chapter content
Bryan O'Sullivan <bos@serpentine.com>
parents: 14
diff changeset
14 \newcommand{\dirname}[1]{\texttt{#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
15
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
16 % File name, with index entry.
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
17 % The ``s'' prefix comes from ``special''.
16
81454425eee9 Progress on a few fronts, mainly indexing and MQ chapter content
Bryan O'Sullivan <bos@serpentine.com>
parents: 14
diff changeset
18 \newcommand{\sfilename}[1]{\index{\texttt{#1} file}\texttt{#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
19
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
20 % Directory name, with index entry.
16
81454425eee9 Progress on a few fronts, mainly indexing and MQ chapter content
Bryan O'Sullivan <bos@serpentine.com>
parents: 14
diff changeset
21 \newcommand{\sdirname}[1]{\index{\texttt{#1} directory}\texttt{#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
22
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
23 % Mercurial extension.
16
81454425eee9 Progress on a few fronts, mainly indexing and MQ chapter content
Bryan O'Sullivan <bos@serpentine.com>
parents: 14
diff changeset
24 \newcommand{\hgext}[1]{\index{\texttt{#1} extension}\texttt{#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
25
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
26 % Mercurial command.
16
81454425eee9 Progress on a few fronts, mainly indexing and MQ chapter content
Bryan O'Sullivan <bos@serpentine.com>
parents: 14
diff changeset
27 \newcommand{\hgcmd}[1]{\index{\texttt{#1} command}``\texttt{hg #1}''}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
28
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
29 % Mercurial command, with arguments.
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
30 \newcommand{\hgcmdargs}[2]{\index{\texttt{#1} command}``\texttt{hg #1 #2}''}
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
31
80
ea951cfb5cd9 Much template-related content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 62
diff changeset
32 \newcommand{\tplkword}[1]{\index{\texttt{#1} template keyword}\index{template keywords!\texttt{#1}}\texttt{#1}}
ea951cfb5cd9 Much template-related content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 62
diff changeset
33
ea951cfb5cd9 Much template-related content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 62
diff changeset
34 \newcommand{\tplkwfilt}[2]{\index{\texttt{#1} template keyword!\texttt{#2}
ea951cfb5cd9 Much template-related content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 62
diff changeset
35 filter}\index{template filters!\texttt{#2}}\index{\texttt{#2}
ea951cfb5cd9 Much template-related content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 62
diff changeset
36 template filter}\texttt{#2}}
ea951cfb5cd9 Much template-related content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 62
diff changeset
37
ea951cfb5cd9 Much template-related content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 62
diff changeset
38 \newcommand{\tplfilter}[1]{\index{template
ea951cfb5cd9 Much template-related content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 62
diff changeset
39 filters!\texttt{#1}}\index{\texttt{#1} template
ea951cfb5cd9 Much template-related content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 62
diff changeset
40 filter}\texttt{#1}}
ea951cfb5cd9 Much template-related content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 62
diff changeset
41
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
42 % Shell/system command.
16
81454425eee9 Progress on a few fronts, mainly indexing and MQ chapter content
Bryan O'Sullivan <bos@serpentine.com>
parents: 14
diff changeset
43 \newcommand{\command}[1]{\index{\texttt{#1} command}\texttt{#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
44
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
45 % Shell/system command, with arguments.
26
1bc6c1f0192a More MQ content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 19
diff changeset
46 \newcommand{\cmdargs}[2]{\index{\texttt{#1} command}``\texttt{#1 #2}''}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
47
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
48 % Mercurial command option.
17
2668e15c76e9 MQ: write up patch rebasing.
Bryan O'Sullivan <bos@serpentine.com>
parents: 16
diff changeset
49 \newcommand{\hgopt}[2]{\index{\texttt{#1} command!\texttt{#2} option}\texttt{#2}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
50
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
51 % Mercurial global option.
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
52 \newcommand{\hggopt}[1]{\index{global options!\texttt{#1} option}\texttt{#1}}
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
53
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
54 % Shell/system command option.
19
187702df428b Piles of new content for MQ chapter - cookbook stuff.
Bryan O'Sullivan <bos@serpentine.com>
parents: 17
diff changeset
55 \newcommand{\cmdopt}[2]{\index{\texttt{#1} command!\texttt{#2} option}\texttt{#2}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
56
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
57 % Command option.
27
535e87792eb1 More MQ content and examples.
Bryan O'Sullivan <bos@serpentine.com>
parents: 26
diff changeset
58 \newcommand{\option}[1]{\texttt{#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
59
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
60 % Software package.
16
81454425eee9 Progress on a few fronts, mainly indexing and MQ chapter content
Bryan O'Sullivan <bos@serpentine.com>
parents: 14
diff changeset
61 \newcommand{\package}[1]{\index{\texttt{#1} package}\texttt{#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
62
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
63 % Section name from a hgrc file.
34
c0979ed1eabd Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 27
diff changeset
64 \newcommand{\rcsection}[1]{\index{\texttt{hgrc} file!\texttt{#1} section}\texttt{[#1]}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
65
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
66 % Named item in a hgrc file section.
34
c0979ed1eabd Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 27
diff changeset
67 \newcommand{\rcitem}[2]{\index{\texttt{hgrc} file!\texttt{#1}
62
8806b2875f10 Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 59
diff changeset
68 section!\texttt{#2} entry}\texttt{#2}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
69
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
70 % hgrc file.
34
c0979ed1eabd Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 27
diff changeset
71 \newcommand{\hgrc}{\index{\texttt{hgrc} file}\texttt{hgrc}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
72
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
73 % Hook name.
34
c0979ed1eabd Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 27
diff changeset
74 \newcommand{\hook}[1]{\index{\texttt{#1} hook}\index{hooks!\texttt{#1}}\texttt{#1}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
75
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
76 % Environment variable.
34
c0979ed1eabd Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 27
diff changeset
77 \newcommand{\envar}[1]{\index{\texttt{#1} environment
c0979ed1eabd Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 27
diff changeset
78 variable}\index{environment variables!\texttt{#1}}\texttt{#1}}
0
76fba5835a1b Beginnings of a build process and file layout.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
79
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
80 % Python module.
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
81 \newcommand{\pymod}[1]{\index{\texttt{#1} module}\texttt{#1}}
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
82
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
83 % Python class in a module.
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
84 \newcommand{\pymodclass}[2]{\index{\texttt{#1} module!\texttt{#2}
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
85 class}\texttt{#1.#2}}
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
86
62
8806b2875f10 Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 59
diff changeset
87 % Python function in a module.
8806b2875f10 Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 59
diff changeset
88 \newcommand{\pymodfunc}[2]{\index{\texttt{#1} module!\texttt{#2}
8806b2875f10 Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 59
diff changeset
89 function}\texttt{#1.#2}}
8806b2875f10 Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 59
diff changeset
90
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
91 % Note: blah blah.
7
339e75288632 More progress on MQ chapter and general support.
Bryan O'Sullivan <bos@serpentine.com>
parents: 4
diff changeset
92 \newsavebox{\notebox}
11
e9d5b4c3d16b First SVG image!
Bryan O'Sullivan <bos@serpentine.com>
parents: 9
diff changeset
93 \newenvironment{note}%
e9d5b4c3d16b First SVG image!
Bryan O'Sullivan <bos@serpentine.com>
parents: 9
diff changeset
94 {\begin{lrbox}{\notebox}\begin{minipage}{0.7\textwidth}\textbf{Note:}\space}%
e9d5b4c3d16b First SVG image!
Bryan O'Sullivan <bos@serpentine.com>
parents: 9
diff changeset
95 {\end{minipage}\end{lrbox}\fbox{\usebox{\notebox}}}
56
b8539d91c84d Begining of concepts chapter
Josef "Jeff" Sipek <jeffpc@josefsipek.net>
parents: 34
diff changeset
96 \newenvironment{caution}%
b8539d91c84d Begining of concepts chapter
Josef "Jeff" Sipek <jeffpc@josefsipek.net>
parents: 34
diff changeset
97 {\begin{lrbox}{\notebox}\begin{minipage}{0.7\textwidth}\textbf{Caution:}\space}%
b8539d91c84d Begining of concepts chapter
Josef "Jeff" Sipek <jeffpc@josefsipek.net>
parents: 34
diff changeset
98 {\end{minipage}\end{lrbox}\fbox{\usebox{\notebox}}}
7
339e75288632 More progress on MQ chapter and general support.
Bryan O'Sullivan <bos@serpentine.com>
parents: 4
diff changeset
99
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
100 % Code sample, eating 4 characters of leading space.
4
33a2e7b9978d Make it possible to include example input and output from real programs.
Bryan O'Sullivan <bos@serpentine.com>
parents: 3
diff changeset
101 \DefineVerbatimEnvironment{codesample4}{Verbatim}{frame=single,gobble=4,numbers=left,commandchars=\\\{\}}
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
102
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
103 % Code sample, eating 2 characters of leading space.
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
104 \DefineVerbatimEnvironment{codesample2}{Verbatim}{frame=single,gobble=2,numbers=left,commandchars=\\\{\}}
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
105
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
106 % Interaction from the examples directory.
4
33a2e7b9978d Make it possible to include example input and output from real programs.
Bryan O'Sullivan <bos@serpentine.com>
parents: 3
diff changeset
107 \newcommand{\interaction}[1]{\VerbatimInput[frame=single,numbers=left,commandchars=\\\{\}]{examples/#1.out}}
3
906d9021f9e5 Making progress on autogenerated example output.
Bryan O'Sullivan <bos@serpentine.com>
parents: 2
diff changeset
108
37
9fd0c59b009a Add to hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents: 35
diff changeset
109 % Graphics inclusion.
11
e9d5b4c3d16b First SVG image!
Bryan O'Sullivan <bos@serpentine.com>
parents: 9
diff changeset
110 \ifpdf
103
5b80c922ebdd More merge content.
Bryan O'Sullivan <bos@serpentine.com>
parents: 80
diff changeset
111 \newcommand{\grafix}[1]{\includegraphics{#1}}
11
e9d5b4c3d16b First SVG image!
Bryan O'Sullivan <bos@serpentine.com>
parents: 9
diff changeset
112 \else
e9d5b4c3d16b First SVG image!
Bryan O'Sullivan <bos@serpentine.com>
parents: 9
diff changeset
113 \newcommand{\grafix}[1]{\includegraphics{#1.png}}
e9d5b4c3d16b First SVG image!
Bryan O'Sullivan <bos@serpentine.com>
parents: 9
diff changeset
114 \fi
e9d5b4c3d16b First SVG image!
Bryan O'Sullivan <bos@serpentine.com>
parents: 9
diff changeset
115
0
76fba5835a1b Beginnings of a build process and file layout.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
116 %%% Local Variables:
76fba5835a1b Beginnings of a build process and file layout.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
117 %%% mode: latex
76fba5835a1b Beginnings of a build process and file layout.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
118 %%% TeX-master: "00book"
76fba5835a1b Beginnings of a build process and file layout.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff changeset
119 %%% End: