comparison en/99defs.tex @ 57:fa8bafe467cb

Merge with upstream
author Josef "Jeff" Sipek <jeffpc@josefsipek.net>
date Tue, 25 Jul 2006 00:02:24 -0400
parents b8539d91c84d b49a7dd4e564
children 3649ee841264
comparison
equal deleted inserted replaced
56:b8539d91c84d 57:fa8bafe467cb
1 \newcommand{\bug}[1]{\index{Mercurial issue!no.~#1}\href{http://www.selenic.com/mercurial/bts/issue#1}{Mercurial issue no.~#1}} 1 % Bug ID.
2 \newcommand{\bug}[1]{\index{Mercurial bug
3 database!\href{http://www.selenic.com/mercurial/bts/issue#1}{bug
4 ~#1}}\href{http://www.selenic.com/mercurial/bts/issue#1}{Mercurial
5 bug no.~#1}}
6
7 % File name in the user's home directory.
2 \newcommand{\tildefile}[1]{\texttt{\~{}/#1}} 8 \newcommand{\tildefile}[1]{\texttt{\~{}/#1}}
9
10 % File name.
3 \newcommand{\filename}[1]{\texttt{#1}} 11 \newcommand{\filename}[1]{\texttt{#1}}
12
13 % Directory name.
4 \newcommand{\dirname}[1]{\texttt{#1}} 14 \newcommand{\dirname}[1]{\texttt{#1}}
15
16 % File name, with index entry.
17 % The ``s'' prefix comes from ``special''.
5 \newcommand{\sfilename}[1]{\index{\texttt{#1} file}\texttt{#1}} 18 \newcommand{\sfilename}[1]{\index{\texttt{#1} file}\texttt{#1}}
19
20 % Directory name, with index entry.
6 \newcommand{\sdirname}[1]{\index{\texttt{#1} directory}\texttt{#1}} 21 \newcommand{\sdirname}[1]{\index{\texttt{#1} directory}\texttt{#1}}
22
23 % Mercurial extension.
7 \newcommand{\hgext}[1]{\index{\texttt{#1} extension}\texttt{#1}} 24 \newcommand{\hgext}[1]{\index{\texttt{#1} extension}\texttt{#1}}
25
26 % Mercurial command.
8 \newcommand{\hgcmd}[1]{\index{\texttt{#1} command}``\texttt{hg #1}''} 27 \newcommand{\hgcmd}[1]{\index{\texttt{#1} command}``\texttt{hg #1}''}
28
29 % Mercurial command, with arguments.
30 \newcommand{\hgcmdargs}[2]{\index{\texttt{#1} command}``\texttt{hg #1 #2}''}
31
32 % Shell/system command.
9 \newcommand{\command}[1]{\index{\texttt{#1} command}\texttt{#1}} 33 \newcommand{\command}[1]{\index{\texttt{#1} command}\texttt{#1}}
34
35 % Shell/system command, with arguments.
10 \newcommand{\cmdargs}[2]{\index{\texttt{#1} command}``\texttt{#1 #2}''} 36 \newcommand{\cmdargs}[2]{\index{\texttt{#1} command}``\texttt{#1 #2}''}
11 \newcommand{\hgcmdargs}[2]{\index{\texttt{#1} command}``\texttt{hg #1 #2}''} 37
38 % Mercurial command option.
12 \newcommand{\hgopt}[2]{\index{\texttt{#1} command!\texttt{#2} option}\texttt{#2}} 39 \newcommand{\hgopt}[2]{\index{\texttt{#1} command!\texttt{#2} option}\texttt{#2}}
40
41 % Mercurial global option.
42 \newcommand{\hggopt}[1]{\index{global options!\texttt{#1} option}\texttt{#1}}
43
44 % Shell/system command option.
13 \newcommand{\cmdopt}[2]{\index{\texttt{#1} command!\texttt{#2} option}\texttt{#2}} 45 \newcommand{\cmdopt}[2]{\index{\texttt{#1} command!\texttt{#2} option}\texttt{#2}}
46
47 % Command option.
14 \newcommand{\option}[1]{\texttt{#1}} 48 \newcommand{\option}[1]{\texttt{#1}}
49
50 % Software package.
15 \newcommand{\package}[1]{\index{\texttt{#1} package}\texttt{#1}} 51 \newcommand{\package}[1]{\index{\texttt{#1} package}\texttt{#1}}
52
53 % Section name from a hgrc file.
16 \newcommand{\rcsection}[1]{\index{\texttt{hgrc} file!\texttt{#1} section}\texttt{[#1]}} 54 \newcommand{\rcsection}[1]{\index{\texttt{hgrc} file!\texttt{#1} section}\texttt{[#1]}}
55
56 % Named item in a hgrc file section.
17 \newcommand{\rcitem}[2]{\index{\texttt{hgrc} file!\texttt{#1} 57 \newcommand{\rcitem}[2]{\index{\texttt{hgrc} file!\texttt{#1}
18 section!\texttt{#2} entry}\texttt{#1.#2}} 58 section!\texttt{#2} entry}\texttt{#1.#2}}
59
60 % hgrc file.
19 \newcommand{\hgrc}{\index{\texttt{hgrc} file}\texttt{hgrc}} 61 \newcommand{\hgrc}{\index{\texttt{hgrc} file}\texttt{hgrc}}
62
63 % Hook name.
20 \newcommand{\hook}[1]{\index{\texttt{#1} hook}\index{hooks!\texttt{#1}}\texttt{#1}} 64 \newcommand{\hook}[1]{\index{\texttt{#1} hook}\index{hooks!\texttt{#1}}\texttt{#1}}
65
66 % Environment variable.
21 \newcommand{\envar}[1]{\index{\texttt{#1} environment 67 \newcommand{\envar}[1]{\index{\texttt{#1} environment
22 variable}\index{environment variables!\texttt{#1}}\texttt{#1}} 68 variable}\index{environment variables!\texttt{#1}}\texttt{#1}}
23 69
70 % Python module.
71 \newcommand{\pymod}[1]{\index{\texttt{#1} module}\texttt{#1}}
72
73 % Python class in a module.
74 \newcommand{\pymodclass}[2]{\index{\texttt{#1} module!\texttt{#2}
75 class}\texttt{#1.#2}}
76
77 % Note: blah blah.
24 \newsavebox{\notebox} 78 \newsavebox{\notebox}
25 \newenvironment{note}% 79 \newenvironment{note}%
26 {\begin{lrbox}{\notebox}\begin{minipage}{0.7\textwidth}\textbf{Note:}\space}% 80 {\begin{lrbox}{\notebox}\begin{minipage}{0.7\textwidth}\textbf{Note:}\space}%
27 {\end{minipage}\end{lrbox}\fbox{\usebox{\notebox}}} 81 {\end{minipage}\end{lrbox}\fbox{\usebox{\notebox}}}
28 \newenvironment{caution}% 82 \newenvironment{caution}%
29 {\begin{lrbox}{\notebox}\begin{minipage}{0.7\textwidth}\textbf{Caution:}\space}% 83 {\begin{lrbox}{\notebox}\begin{minipage}{0.7\textwidth}\textbf{Caution:}\space}%
30 {\end{minipage}\end{lrbox}\fbox{\usebox{\notebox}}} 84 {\end{minipage}\end{lrbox}\fbox{\usebox{\notebox}}}
31 85
86 % Code sample, eating 4 characters of leading space.
32 \DefineVerbatimEnvironment{codesample4}{Verbatim}{frame=single,gobble=4,numbers=left,commandchars=\\\{\}} 87 \DefineVerbatimEnvironment{codesample4}{Verbatim}{frame=single,gobble=4,numbers=left,commandchars=\\\{\}}
88
89 % Code sample, eating 2 characters of leading space.
90 \DefineVerbatimEnvironment{codesample2}{Verbatim}{frame=single,gobble=2,numbers=left,commandchars=\\\{\}}
91
92 % Interaction from the examples directory.
33 \newcommand{\interaction}[1]{\VerbatimInput[frame=single,numbers=left,commandchars=\\\{\}]{examples/#1.out}} 93 \newcommand{\interaction}[1]{\VerbatimInput[frame=single,numbers=left,commandchars=\\\{\}]{examples/#1.out}}
34 94
95 % Graphics inclusion.
35 \ifpdf 96 \ifpdf
36 \newcommand{\grafix}[1]{\includegraphics[scale=0.2]{#1_pdf.png}} 97 \newcommand{\grafix}[1]{\includegraphics{#1}}
37 \else 98 \else
38 \newcommand{\grafix}[1]{\includegraphics{#1.png}} 99 \newcommand{\grafix}[1]{\includegraphics{#1.png}}
39 \fi 100 \fi
40 101
41 %%% Local Variables: 102 %%% Local Variables: