Mercurial > hgbook
annotate en/99defs.tex @ 184:7b812c428074
Document the ssh protocol, URL syntax, and configuration.
author | Bryan O'Sullivan <bos@serpentine.com> |
---|---|
date | Thu, 05 Apr 2007 23:28:06 -0700 |
parents | 65f6f9d18fa1 |
children | f83281da4122 |
rev | line source |
---|---|
37 | 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 | 6 |
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 | 9 |
10 % File name. | |
2 | 11 \newcommand{\filename}[1]{\texttt{#1}} |
37 | 12 |
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 | 15 |
16 % File name, with index entry. | |
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 | 19 |
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 | 22 |
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 | 25 |
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 | 28 |
29 % Mercurial command, with arguments. | |
30 \newcommand{\hgcmdargs}[2]{\index{\texttt{#1} command}``\texttt{hg #1 #2}''} | |
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 | 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 | 44 |
45 % Shell/system command, with arguments. | |
26 | 46 \newcommand{\cmdargs}[2]{\index{\texttt{#1} command}``\texttt{#1 #2}''} |
37 | 47 |
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 | 50 |
51 % Mercurial global option. | |
52 \newcommand{\hggopt}[1]{\index{global options!\texttt{#1} option}\texttt{#1}} | |
53 | |
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 | 56 |
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 | 59 |
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 | 62 |
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 | 65 |
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 | 69 |
70 % hgrc file. | |
184
7b812c428074
Document the ssh protocol, URL syntax, and configuration.
Bryan O'Sullivan <bos@serpentine.com>
parents:
146
diff
changeset
|
71 \newcommand{\hgrc}{\index{configuration file!\texttt{hgrc} |
7b812c428074
Document the ssh protocol, URL syntax, and configuration.
Bryan O'Sullivan <bos@serpentine.com>
parents:
146
diff
changeset
|
72 (Linux/Unix)}\index{\texttt{hgrc} configuration file}\texttt{hgrc}} |
7b812c428074
Document the ssh protocol, URL syntax, and configuration.
Bryan O'Sullivan <bos@serpentine.com>
parents:
146
diff
changeset
|
73 |
7b812c428074
Document the ssh protocol, URL syntax, and configuration.
Bryan O'Sullivan <bos@serpentine.com>
parents:
146
diff
changeset
|
74 % Mercurial.ini file. |
7b812c428074
Document the ssh protocol, URL syntax, and configuration.
Bryan O'Sullivan <bos@serpentine.com>
parents:
146
diff
changeset
|
75 \newcommand{\hgini}{\index{configuration file!\texttt{Mercurial.ini} |
7b812c428074
Document the ssh protocol, URL syntax, and configuration.
Bryan O'Sullivan <bos@serpentine.com>
parents:
146
diff
changeset
|
76 (Windows)}\index{\texttt{Mercurial.ini} configuration file}\texttt{Mercurial.ini}} |
37 | 77 |
78 % Hook name. | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
27
diff
changeset
|
79 \newcommand{\hook}[1]{\index{\texttt{#1} hook}\index{hooks!\texttt{#1}}\texttt{#1}} |
37 | 80 |
81 % Environment variable. | |
34
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
27
diff
changeset
|
82 \newcommand{\envar}[1]{\index{\texttt{#1} environment |
c0979ed1eabd
Get started on hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
27
diff
changeset
|
83 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
|
84 |
37 | 85 % Python module. |
86 \newcommand{\pymod}[1]{\index{\texttt{#1} module}\texttt{#1}} | |
87 | |
88 % Python class in a module. | |
89 \newcommand{\pymodclass}[2]{\index{\texttt{#1} module!\texttt{#2} | |
90 class}\texttt{#1.#2}} | |
91 | |
62
8806b2875f10
Finish off a big whack of content for the hook chapter.
Bryan O'Sullivan <bos@serpentine.com>
parents:
59
diff
changeset
|
92 % 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
|
93 \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
|
94 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
|
95 |
37 | 96 % Note: blah blah. |
7
339e75288632
More progress on MQ chapter and general support.
Bryan O'Sullivan <bos@serpentine.com>
parents:
4
diff
changeset
|
97 \newsavebox{\notebox} |
11 | 98 \newenvironment{note}% |
99 {\begin{lrbox}{\notebox}\begin{minipage}{0.7\textwidth}\textbf{Note:}\space}% | |
100 {\end{minipage}\end{lrbox}\fbox{\usebox{\notebox}}} | |
56
b8539d91c84d
Begining of concepts chapter
Josef "Jeff" Sipek <jeffpc@josefsipek.net>
parents:
34
diff
changeset
|
101 \newenvironment{caution}% |
b8539d91c84d
Begining of concepts chapter
Josef "Jeff" Sipek <jeffpc@josefsipek.net>
parents:
34
diff
changeset
|
102 {\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
|
103 {\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
|
104 |
37 | 105 % 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
|
106 \DefineVerbatimEnvironment{codesample4}{Verbatim}{frame=single,gobble=4,numbers=left,commandchars=\\\{\}} |
37 | 107 |
108 % Code sample, eating 2 characters of leading space. | |
109 \DefineVerbatimEnvironment{codesample2}{Verbatim}{frame=single,gobble=2,numbers=left,commandchars=\\\{\}} | |
110 | |
111 % Interaction from the examples directory. | |
146
65f6f9d18fa1
Oops! I forgot that I need the undoctored output files in the book!
Bryan O'Sullivan <bos@serpentine.com>
parents:
133
diff
changeset
|
112 \newcommand{\interaction}[1]{\VerbatimInput[frame=single,numbers=left,commandchars=\\\{\}]{examples/#1.lxo}} |
106
9cbc5d0db542
Finish off advanced MQ chapter (maybe).
Bryan O'Sullivan <bos@serpentine.com>
parents:
103
diff
changeset
|
113 % Example code from the examples directory. |
9cbc5d0db542
Finish off advanced MQ chapter (maybe).
Bryan O'Sullivan <bos@serpentine.com>
parents:
103
diff
changeset
|
114 \newcommand{\excode}[1]{\VerbatimInput[frame=single,numbers=left,commandchars=\\\{\}]{../examples/#1}} |
9cbc5d0db542
Finish off advanced MQ chapter (maybe).
Bryan O'Sullivan <bos@serpentine.com>
parents:
103
diff
changeset
|
115 |
37 | 116 % Graphics inclusion. |
11 | 117 \ifpdf |
103 | 118 \newcommand{\grafix}[1]{\includegraphics{#1}} |
11 | 119 \else |
120 \newcommand{\grafix}[1]{\includegraphics{#1.png}} | |
121 \fi | |
122 | |
132
e1e2f3e0256a
Start command reference, with the diff command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
106
diff
changeset
|
123 % Reference entry for a command. |
133
1e013fbe35f7
Lots of filename related content. A little more command reference
Bryan O'Sullivan <bos@serpentine.com>
parents:
132
diff
changeset
|
124 \newcommand{\cmdref}[2]{\section{\hgcmd{#1}---#2}\label{cmdref:#1}\index{\texttt{#1} command}} |
132
e1e2f3e0256a
Start command reference, with the diff command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
106
diff
changeset
|
125 |
133
1e013fbe35f7
Lots of filename related content. A little more command reference
Bryan O'Sullivan <bos@serpentine.com>
parents:
132
diff
changeset
|
126 % Reference entry for a command option with long and short forms. |
1e013fbe35f7
Lots of filename related content. A little more command reference
Bryan O'Sullivan <bos@serpentine.com>
parents:
132
diff
changeset
|
127 \newcommand{\optref}[3]{\subsubsection{\hgopt{#1}{--#3}, also \hgopt{#1}{-#2}}} |
1e013fbe35f7
Lots of filename related content. A little more command reference
Bryan O'Sullivan <bos@serpentine.com>
parents:
132
diff
changeset
|
128 |
1e013fbe35f7
Lots of filename related content. A little more command reference
Bryan O'Sullivan <bos@serpentine.com>
parents:
132
diff
changeset
|
129 % Reference entry for a command option with only long form. |
1e013fbe35f7
Lots of filename related content. A little more command reference
Bryan O'Sullivan <bos@serpentine.com>
parents:
132
diff
changeset
|
130 \newcommand{\loptref}[2]{\subsubsection{\hgopt{#1}{--#2} option}} |
132
e1e2f3e0256a
Start command reference, with the diff command.
Bryan O'Sullivan <bos@serpentine.com>
parents:
106
diff
changeset
|
131 |
0
76fba5835a1b
Beginnings of a build process and file layout.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
132 %%% Local Variables: |
76fba5835a1b
Beginnings of a build process and file layout.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
133 %%% mode: latex |
76fba5835a1b
Beginnings of a build process and file layout.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
134 %%% TeX-master: "00book" |
76fba5835a1b
Beginnings of a build process and file layout.
Bryan O'Sullivan <bos@serpentine.com>
parents:
diff
changeset
|
135 %%% End: |