all repos — h3rald @ 6b243ded05a7593922d198634c681075de1c12e2

The sources of https://h3rald.com

contents/glyph/book/stats/stats.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
-----
title: "Glyph - Using the stats command"
content-type: page
-----
<nav class="navigation"><a href="/glyph/book/compiling/programmatic_usage.html">← Using Glyph programmatically</a> | <a
		href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/macros.html">Macro Statistics →</a>
</nav>

<p>Glyph includes a <a href="/glyph/book/ref_commands.html#c_stats"><code>stats</code></a> command that can be used to
	display useful statistics about your Glyph project. If you try running Glyph's command help, you'll see that this
	command can take quite a few options:
</p>
<div class="CodeRay">
	<div class="code">
		<pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>$ glyph help stats
<span class="line-numbers"> <a href="#n2" name="n2">2</a></span>Glyph v0.5.0
<span class="line-numbers"> <a href="#n3" name="n3">3</a></span>
<span class="line-numbers"> <a href="#n4" name="n4">4</a></span>stats [options] 
<span class="line-numbers"> <a href="#n5" name="n5">5</a></span>    Display statistics
<span class="line-numbers"> <a href="#n6" name="n6">6</a></span>
<span class="line-numbers"> <a href="#n7" name="n7">7</a></span>Options:
<span class="line-numbers"> <a href="#n8" name="n8">8</a></span>    -b, --bookmarks - Display stats about bookmarks
<span class="line-numbers"> <a href="#n9" name="n9">9</a></span>    --bookmark=arg  - Display stats about a single bookmark
<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span>    -f, --files     - Display stats about project files
<span class="line-numbers"><a href="#n11" name="n11">11</a></span>    -l, --links     - Display stats about links
<span class="line-numbers"><a href="#n12" name="n12">12</a></span>    --link=arg      - Display stats about links matching a regular expression
<span class="line-numbers"><a href="#n13" name="n13">13</a></span>    -m, --macros    - Display stats about macros
<span class="line-numbers"><a href="#n14" name="n14">14</a></span>    --macro=arg     - Display stats about a single macro
<span class="line-numbers"><a href="#n15" name="n15">15</a></span>    -s, --snippets  - Display stats about snippets
<span class="line-numbers"><a href="#n16" name="n16">16</a></span>    --snippet=arg   - Display stats about a single snippet</pre>
	</div>
</div>

<p>If no options are specified, the command returns a summary containing different element totals, i.e.:</p>
<ul>
	<li>The files used in the project</li>
	<li>Macro definitions and instances</li>
	<li>Snippets</li>
	<li>Bookmarks</li>
	<li>Links and references</li>
</ul>
<p>Example:</p>
<div class="CodeRay">
	<div class="code">
		<pre><span class="line-numbers"> <a href="#n1" name="n1">1</a></span>=====================================
<span class="line-numbers"> <a href="#n2" name="n2">2</a></span>Glyph - Statistics
<span class="line-numbers"> <a href="#n3" name="n3">3</a></span>=====================================
<span class="line-numbers"> <a href="#n4" name="n4">4</a></span>
<span class="line-numbers"> <a href="#n5" name="n5">5</a></span>===== Files
<span class="line-numbers"> <a href="#n6" name="n6">6</a></span>-- Total Files: 50
<span class="line-numbers"> <a href="#n7" name="n7">7</a></span>-- /text    -- 46
<span class="line-numbers"> <a href="#n8" name="n8">8</a></span>-- /images  -- 3
<span class="line-numbers"> <a href="#n9" name="n9">9</a></span>-- /styles  -- 0
<span class="line-numbers"><strong><a href="#n10" name="n10">10</a></strong></span>-- /layouts -- 0
<span class="line-numbers"><a href="#n11" name="n11">11</a></span>-- /lib     -- 1
<span class="line-numbers"><a href="#n12" name="n12">12</a></span>
<span class="line-numbers"><a href="#n13" name="n13">13</a></span>===== Macros
<span class="line-numbers"><a href="#n14" name="n14">14</a></span>-- Total Macro Instances: 2950
<span class="line-numbers"><a href="#n15" name="n15">15</a></span>-- Total Macro Definitions: 22
<span class="line-numbers"><a href="#n16" name="n16">16</a></span>-- Total Macro Aliases: 57
<span class="line-numbers"><a href="#n17" name="n17">17</a></span>-- Total Used Macro Definitions: 60
<span class="line-numbers"><a href="#n18" name="n18">18</a></span>
<span class="line-numbers"><a href="#n19" name="n19">19</a></span>===== Snippets
<span class="line-numbers"><strong><a href="#n20" name="n20">20</a></strong></span>-- Total Snippets: 21
<span class="line-numbers"><a href="#n21" name="n21">21</a></span>-- Total Used Snippets: 21
<span class="line-numbers"><a href="#n22" name="n22">22</a></span>-- Total Unused Snippets: 0
<span class="line-numbers"><a href="#n23" name="n23">23</a></span>
<span class="line-numbers"><a href="#n24" name="n24">24</a></span>===== Bookmarks
<span class="line-numbers"><a href="#n25" name="n25">25</a></span>-- Total Bookmarks: 221
<span class="line-numbers"><a href="#n26" name="n26">26</a></span>-- Total Referenced Bookmarks: 87
<span class="line-numbers"><a href="#n27" name="n27">27</a></span>-- Total Unreferenced Bookmarks: 135
<span class="line-numbers"><a href="#n28" name="n28">28</a></span>
<span class="line-numbers"><a href="#n29" name="n29">29</a></span>===== Links
<span class="line-numbers"><strong><a href="#n30" name="n30">30</a></strong></span>-- Total Internal Links: 87
<span class="line-numbers"><a href="#n31" name="n31">31</a></span>-- Total External Links: 97</pre>
	</div>
</div>

<nav class="navigation"><a href="/glyph/book/compiling/programmatic_usage.html">← Using Glyph programmatically</a> | <a
		href="/glyph/book/index.html">Contents</a> | <a href="/glyph/book/stats/macros.html">Macro Statistics →</a>
</nav>