-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathdoc-guide.html.bak
113 lines (76 loc) · 3.72 KB
/
doc-guide.html.bak
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<title>The Tor-BSD Diversity Project : Documentation Style Guide</title>
<link type="text/css" rel="stylesheet" href="torbsd.css"/>
<meta name="author" content="gman"/>
<meta name="editors" content="attila"/>
<meta name="date" content="2015-05-14"/>
<meta name="note" content="These lines at the top are multimarkdown metadata; leave them."/>
<meta name="sep" content="&#8916;"/>
</head>
<body>
<h1 id="thetorbsddiversityprojecttdp"><a href="index.html">The Tor BSD Diversity Project (TDP)</a></h1>
<p>&#8916; <a href="blog.html">Blog</a> &#8916; <a href="faq.html">FAQ</a> &#8916; <a href="resources.html">Resources</a> &#8916; <a href="https://github.com/torbsd/">GitHub</a> &#8916; <a href="contact.html">Contact</a> &#8916; <a href="http://bptfp7py2wclht26.onion/">TDP Onion</a> &#8916;</p>
<p><strong><a href="projects.html">The TDP Projects</a>:</strong><br/>
&#8916; <a href="https://github.com/torbsd/openbsd-ports/">Tor Browser for OpenBSD</a> &#8916; <a href="relay-guides.html">BSD Relay Guides</a> &#8916; <a href="corp-relays.html">Corporate Relays</a> &#8916; <a href="porting-pets.html">Ports for PETs</a> &#8916; <a href="oostats.html">Statistics</a> &#8916;</p>
<h2 id="documentationstyleguide">Documentation Style Guide</h2>
<p>This piece is meant to illustrate <strong>TDP</strong> documentation. This is standard for all <strong>TDP</strong> syntax in the tutorials and guides.</p>
<h3 id="shellcommand-line">Shell/Command-Line</h3>
<p>All shell commands will be indicated by a dollar sign <code>$</code>, the default symbol of /bin/ksh, which a single-tab indent.</p>
<p>Example:</p>
<blockquote>
<p>$ <em>run this command</em></p>
</blockquote>
<h3 id="filenamesandpaths">File Names and Paths</h3>
<p>Both file names and paths are in <strong>bold</strong>, unless it is part of a shell command.</p>
<p>Examples:</p>
<blockquote>
<p>Change to the <strong>/usr/ports/mystuff/openbsd-ports/www/tbb/tor-browser</strong> directory.</p>
<p>Edit the <strong>torrc</strong> file.</p>
</blockquote>
<h3 id="baseoperatingsystemcommands">Base Operating System Commands</h3>
<p>When base programs are referenced, they are appended with a number, representing the relevant manual page.</p>
<p>Example:</p>
<blockquote>
<p>ls(1)</p>
</blockquote>
<p>That particular manual page can be accessed by typing:</p>
<blockquote>
<p>$ man 1 ls</p>
</blockquote>
<p>The standard manual page sections are:</p>
<p>1 General commands (tools and utilities).<br/>
2 System calls and error numbers.<br/>
3 Libraries.<br/>
3f Fortran programmer’s reference guide.<br/>
3p perl(1) programmer’s reference guide.<br/>
4 Device drivers.<br/>
5 File formats.<br/>
6 Games.<br/>
7 Miscellaneous.<br/>
8 System maintenance and operation commands.<br/>
9 Kernel internals. </p>
<h3 id="editsadditionsdeletionsfromfiles">Edits/Additions/Deletions from Files</h3>
<p>The standard notation for adding lines is the plus symbol <code>+</code></p>
<p>Example:</p>
<pre><code>>+*add this line*
</code></pre>
<p>Removing lines is indicated by the minus symbol <code>-</code></p>
<p>Example:</p>
<pre><code>>-*remove this line*
</code></pre>
<h3 id="outputfromcommands">Output from Commands</h3>
<p>After a command is run, there is often expected output that is displayed on the screen which is indicated by <em>italics</em>. In this example, Tor is restarted.</p>
<p>Example:</p>
<pre><code>>$ sudo /etc/rc.d/tor restart
*tor(ok)*
*tor(ok)*
$
</code></pre>
<p><hr></p>
<p><em>Copyright © 2018 by The Tor BSD Diversity Project (TDP). All Rights Reserved.</em></p>
<p><code>last updated: Tue Jun 13 19:25:38 2017 UTC</code></p>
</body>
</html>