all repos — h3rald @ b3442cd80d633f1412303de98a8301e8b8fd86c0

The sources of https://h3rald.com

contents/glyph/book/ref_commands.html

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
-----
title: "Glyph - Command Reference"
content-type: page
-----
<nav class="navigation"><a href="/glyph/book/troubleshooting/errors_macro.html">← Macro Errors</a> | <a
		href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_core.html">Core Macros →</a>
</nav>
<p>Glyph&#8217;s command-line interface has been built using the <a href="http://github.com/davetron5000/gli">gli</a>
	(Git-like interface) gem. Therefore, Glyph commands are all written like this:</p>
<p><strong>glyph</strong> <em>global_options</em> <strong>command</strong> <em>options</em> <em>parameters</em></p>
<p>Where:</p>
<ul>
	<li><em>global_options</em> and <em>options</em> are in the form: <code>-n</code> <em>value</em> or
		<code>--name=</code><em>value</em>, e.g. <code>-f pdf</code> or <code>--format=pdf</code>
	</li>
	<li><em>parameters</em> are separated by whitespaces, and can be wrapped in quotes.</li>
</ul>
<section class="section">
	<header>
		<h1 id="h_115" class="toc">Global Options</h1>
	</header>
	<section class="section">
		<header>
			<h1 id="debug_switch" class="toc"><code>-d</code>, <code>--debug</code></h1>
		</header>
		<p>If specified, the command is executed in debug mode and additional diagnostic information is printed on the
			screen.</p>

	</section>
	<section class="section">
		<header>
			<h1 id="help_switch" class="toc"><code>-h</code>, <code>--help</code></h1>
		</header>
		<p>Displays help on the program.</p>

	</section>

</section>
<section class="section">
	<header>
		<h1 id="c_add" class="toc"><code>add</code></h1>
	</header>
	<p>Creates a new text file in the <code>text/</code> folder.</p>
	<p><strong>Example:</strong> <code>glyph add introduction.textile</code></p>

	<section class="section">
		<header>
			<h1 id="h_119" class="notoc">Parameters</h1>
		</header>
		<table style="width:100%;">
			<tr>
				<th style="width:30%">Parameter</th>
				<th>Description</th>
			</tr>
			<tr>
				<td><em>file_name</em></td>
				<td>The name (or relative path) of the new file to be created.</td>
			</tr>
		</table>

	</section>

</section>
<section class="section">
	<header>
		<h1 id="c_compile" class="toc"><code>compile</code></h1>
	</header>
	<p>Compiles a Glyph document into an output file. If no options are specified, the <code>document.glyph</code> file
		is used as source to produce a standalone HTML file.</p>
	<p><strong>Example:</strong> <code>glyph compile -f pdf</code></p>

	<section class="section">
		<header>
			<h1 id="h_121" class="notoc">Parameters</h1>
		</header>
		<table style="width:100%;">
			<tr>
				<th style="width:30%">Parameter</th>
				<th>Description</th>
			</tr>
			<tr>
				<td><em>source</em></td>
				<td>The source glyph file to compile <em>(Optional)</em>.</td>
			</tr>


			<tr>
				<td><em>destination</em></td>
				<td>The destination file <em>(Optional)</em>.</td>
			</tr>
		</table>

	</section>


	<section class="section">
		<header>
			<h1 id="h_122" class="notoc">Options</h1>
		</header>
		<table style="width:100%;">
			<tr>
				<th style="width:30%">Option</th>
				<th>Description</th>
			</tr>
			<tr>
				<td><code>-s</code> (<code>--source</code>)</td>
				<td>
					The source file to compile.
					<strong>Default Value:</strong> <code>document.glyph</code>
				</td>
			</tr>


			<tr>
				<td><code>-f</code> (<code>--format</code>)</td>
				<td>
					The format of the output file.
					<strong>Default Value:</strong> <code>html</code>
					*Possible Values:* @html, pdf@
				</td>
			</tr>


			<tr>
				<td><code>-a</code> (<code>--auto</code>)</td>
				<td>
					If specified, enable <a href="/glyph/book/compiling/compiling.html#auto_regeneration">auto
						regeneration</a> (requires the <a
						href="http://rubygems.org/gems/directory_watcher">directory_watcher</a> gem to be installed).
				</td>
			</tr>
		</table>

	</section>

</section>
<section class="section">
	<header>
		<h1 id="c_config" class="toc"><code>config</code></h1>
	</header>
	Gets or sets a configuration setting in the project or global configuration file (<span class="fmi">for more
		information on <mark>configuration files</mark>, see <a
			href="/glyph/book/getting_started/configuration.html#cfg">Project Configuration</a></span>).
	<section class="section">
		<header>
			<h1 id="h_124" class="notoc">Examples</h1>
		</header>
		<p>
			<code>glyph config document.filename</code>
		</p>
		<p>
			<code>glyph config -g document.author "Fabio Cevasco"</code>
		</p>

	</section>

	<section class="section">
		<header>
			<h1 id="h_125" class="notoc">Options</h1>
		</header>
		<table style="width:100%;">
			<tr>
				<th style="width:30%">Option</th>
				<th>Description</th>
			</tr>
			<tr>
				<td><code>-g</code> (<code>--global</code>)</td>
				<td>
					If specified, the global configuration file is processed instead of the project file.
					<strong>Default Value:</strong> <code>false</code>
				</td>
			</tr>
		</table>

	</section>


	<section class="section">
		<header>
			<h1 id="h_126" class="notoc">Parameters</h1>
		</header>
		<table style="width:100%;">
			<tr>
				<th style="width:30%">Parameter</th>
				<th>Description</th>
			</tr>
			<tr>
				<td><em>setting</em></td>
				<td>The name of a valid <a href="/glyph/book/config/document.html#cfg_ref">configuration setting</a>.
				</td>
			</tr>


			<tr>
				<td><em>value</em></td>
				<td>The new value of the configuration setting.</td>
			</tr>
		</table>

	</section>

</section>
<section class="section">
	<header>
		<h1 id="c_help" class="toc"><code>help</code></h1>
	</header>
	Prints information about all Glyph commands or about one specific command.
	<section class="section">
		<header>
			<h1 id="h_128" class="notoc">Examples</h1>
		</header>
		<p>
			<code>glyph help</code>
		</p>
		<p>
			<code>glyph help compile</code>
		</p>

	</section>

	<section class="section">
		<header>
			<h1 id="h_129" class="notoc">Parameters</h1>
		</header>
		<table style="width:100%;">
			<tr>
				<th style="width:30%">Parameter</th>
				<th>Description</th>
			</tr>
			<tr>
				<td><em>command</em></td>
				<td>A valid Glyph command.</td>
			</tr>
		</table>

	</section>

</section>
<section class="section">
	<header>
		<h1 id="c_init" class="toc"><code>init</code></h1>
	</header>
	Creates a new Glyph project in the current directory (if empty).
	<p><strong>Example:</strong> <code>glyph init</code></p>

</section>
<section class="section">
	<header>
		<h1 id="c_outline" class="toc"><code>outline</code></h1>
	</header>
	Display an outline of the current document.

	<section class="section">
		<header>
			<h1 id="h_132" class="notoc">Options</h1>
		</header>
		<table style="width:100%;">
			<tr>
				<th style="width:30%">Option</th>
				<th>Description</th>
			</tr>
			<tr>
				<td><code>-l</code> (<code>--limit</code>)</td>
				<td>
					Only display headers until the specified level.
				</td>
			</tr>


			<tr>
				<td><code>-i</code> (<code>--ids</code>)</td>
				<td>
					Display section IDs.
				</td>
			</tr>


			<tr>
				<td><code>-f</code> (<code>--files</code>)</td>
				<td>
					Display file names.
				</td>
			</tr>


			<tr>
				<td><code>-t</code> (<code>--titles</code>)</td>
				<td>
					Display section titles.
				</td>
			</tr>
		</table>

	</section>

	<section class="section">
		<header>
			<h1 id="h_133" class="notoc">Examples</h1>
		</header>
		<p>
			<code>glyph outline -it -l 1</code>
		</p>
		<p>
			<code>glyph outline -l 2</code>
		</p>
		<p>
			<code>glyph outline -f</code>
		</p>

	</section>

</section>
<section class="section">
	<header>
		<h1 id="c_stats" class="toc"><code>stats</code></h1>
	</header>
	<p>Displays project statistics (<span class="fmi">for more information on <mark>this command</mark>, see <a
				href="/glyph/book/config/document.html#stats">Document Statistics</a></span>).</p>
	<section class="section">
		<header>
			<h1 id="h_135" class="notoc">Examples</h1>
		</header>
		<p>
			<code>glyph stats -m</code>
		</p>
		<p>
			<code>glyph stats --link=h3rald.com</code>
		</p>

	</section>

	<section class="section">
		<header>
			<h1 id="h_136" class="notoc">Options</h1>
		</header>
		<table style="width:100%;">
			<tr>
				<th style="width:30%">Option</th>
				<th>Description</th>
			</tr>
			<tr>
				<td><code>-b</code> (<code>--bookmarks</code>)</td>
				<td>
					If specified, general statistics about bookmarks are displayed (see <a
						href="/glyph/book/stats/bookmarks.html#stats_bookmarks">Bookmark Statistics</a>).
				</td>
			</tr>


			<tr>
				<td><code>--bookmark</code></td>
				<td>
					Display detailed statistics about the specified bookmark.
				</td>
			</tr>


			<tr>
				<td><code>-f</code> (<code>--files</code>)</td>
				<td>
					If specified, general statistics about project files are displayed.
				</td>
			</tr>


			<tr>
				<td><code>-l</code> (<code>--links</code>)</td>
				<td>
					If specified, general statistics about links are displayed (see <a
						href="/glyph/book/stats/links.html#stats_links">Link Statistics</a>).
				</td>
			</tr>


			<tr>
				<td><code>--link</code></td>
				<td>
					Display detailed statistics about all links whose target matches the specified regular expression.
				</td>
			</tr>


			<tr>
				<td><code>-m</code> (<code>--macros</code>)</td>
				<td>
					If specified, general statistics about macros are displayed (see <a
						href="/glyph/book/stats/macros.html#stats_macros">Macro Statistics</a>).
				</td>
			</tr>


			<tr>
				<td><code>--macro</code></td>
				<td>
					Display detailed statistics about the specified macro.
				</td>
			</tr>


			<tr>
				<td><code>-s</code> (<code>--snippets</code>)</td>
				<td>
					If specified, general statistics about snippets are displayed (see <a
						href="/glyph/book/stats/snippets.html#stats_snippets">Snippet Statistics</a>).
				</td>
			</tr>


			<tr>
				<td><code>--snippet</code></td>
				<td>
					Display detailed statistics about the specified snippet.
				</td>
			</tr>
		</table>

	</section>

</section>
<section class="section">
	<header>
		<h1 id="c_todo" class="toc"><code>todo</code></h1>
	</header>
	Prints all the todo items saved using the <a
		href="/glyph/book/macros/macros_inline.html#m_todo"><code>todo</code></a> macro.
	<p><strong>Example:</strong> <code>glyph todo</code></p>

</section>
<nav class="navigation"><a href="/glyph/book/troubleshooting/errors_macro.html">← Macro Errors</a> | <a
		href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/macros/macros_core.html">Core Macros →</a>
</nav>