Skip to content

Commit 501b368

Browse files
jubalhjubalh
committed
Release 0.15.0
1 parent dda38fb commit 501b368

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+10138
-21
lines changed

‎guide/0150/basic.html‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
<!DOCTYPE html>
2+
<html>
3+
4+
<head>
5+
<title>Profanity, a console based XMPP client - Getting Started</title>
6+
<meta charset="utf-8">
7+
<meta http-equiv="Expires" content="-1">
8+
<meta http-equiv="Pragma" content="no-cache">
9+
<meta http-equiv="Cache-Control" content="no-cache">
10+
<link href="../../css/profanity.css" type="text/css" rel="stylesheet">
11+
12+
</head>
13+
14+
<body id="article">
15+
<img class="overlay" src="../../images/profanity_mouth-only.png" alt="Profanity Illustration">
16+
<header>
17+
<h1>
18+
<a href="userguide.html">
19+
User Guide
20+
</a>
21+
</h1>
22+
<h2>Quick Start Guide</h2>
23+
</header>
24+
<article id="manual">
25+
<section>
26+
<h3>Contents</h3>
27+
28+
<ul>
29+
<li><a href="#starting-profanity">Starting Profanity</a>
30+
<li><a href="#user-interface">User Interface</a>
31+
<li><a href="#switching-between-windows">Window navigation</a>
32+
<li><a href="#connecting">Connecting</a>
33+
<li><a href="#sending-a-message">One to one chat</a>
34+
<li><a href="#room-messages">Chat rooms</a>
35+
<li><a href="#managing-contacts">Adding contacts</a>
36+
<li><a href="#changing-your-presence">Changing your presence</a>
37+
<li><a href="#logging-out">Logging out</a></li>
38+
</ul>
39+
</section>
40+
<section>
41+
<a name="starting-profanity"></a>
42+
<h3>Starting Profanity</h3>
43+
44+
<p>To start Profanity, run the following at the command line:</p>
45+
<pre><code>$ profanity</code></pre>
46+
<p>To see options available to the command:</p>
47+
<pre><code>$ profanity -h</code></pre>
48+
</section>
49+
<section>
50+
<a name="user-interface"></a>
51+
<h3>User Interface</h3>
52+
53+
<p><img src="../../images/main.png" /></p>
54+
<p>The user interface is split into four main areas:</p>
55+
56+
<p><b>Title bar</b></p>
57+
<p><img src="../../images/main1.png" /></p>
58+
<p>Shows the title for the current window (usually the contact you are chatting with, or the chat room you
59+
have joined), and your current presence.</p>
60+
61+
<p><b>Main window area</b></p>
62+
<p><img src="../../images/main2.png" /></p>
63+
<p>Used to show the current active window. The first window (1) is reserved for the 'console' where system
64+
messages and command responses are shown.</p>
65+
66+
<p><b>Status bar</b></p>
67+
<p><img src="../../images/main3.png" /></p>
68+
<p>Shows the time, the user you are logged in as, and status of each window. If a window is used, its number
69+
will appear, if it has new messages of any kind, the number will be highlighted. The current window is
70+
shown as -1-.</p>
71+
72+
<p><b>Input area</b></p>
73+
<p><img src="../../images/main4.png" /></p>
74+
<p>Where commands and messages are entered. Commands and command arguments can be autocompleted with the tab
75+
key.</p>
76+
<p>All commands start with a <code>/</code> character e.g.:</p>
77+
<pre><code>/help</code></pre>
78+
</section>
79+
<section>
80+
<a name="switching-between-windows"></a>
81+
<h3>Window navigation</h3>
82+
83+
<p>To make a window visible in the main window area, use any of the following:<p>
84+
<p>
85+
<code>Alt-1</code> to <code>Alt-0</code><br>
86+
<code>F1</code> to <code>F10</code><br>
87+
<code>Alt-left</code>, <code>Alt-right</code>
88+
</p>
89+
<p>The <a href="reference.html#win"><code>/win</code></a> command may also be used. Either the
90+
window number may be passed, or the window title:</p>
91+
<pre><code>/win 4</code>
92+
<code>/win [email protected]</code>
93+
<code>/win MyBuddy</code></pre>
94+
<p>To close the current window:</p>
95+
<pre><code>/close</code></pre>
96+
</section>
97+
<section>
98+
<a name="connecting"></a>
99+
<h3>Connecting</h3>
100+
101+
<p>To connect to an XMPP chat service:</p>
102+
<pre><code>/connect [email protected]</code></pre>
103+
<p>You will be prompted by the status bar to enter your password.</p>
104+
<p>See the <a href="reference.html#connect"><code>/connect</code></a> command for additional arguments that
105+
may be used when connecting.</p>
106+
</section>
107+
<section>
108+
<a name="sending-a-message"></a>
109+
<h3>One to one chat</h3>
110+
111+
<p>To open a new window and send a message use the <a href="reference.html#msg"><code>/msg</code></a>
112+
command:<p>
113+
<pre><code>/msg [email protected] Hello there!</code></pre>
114+
115+
<p>Profanity uses the contact's nickname by default, if one exists. For example:</p>
116+
<pre><code>/msg Bob Are you there bob?</code></pre>
117+
118+
<p>Once a window is opened with the contact, messages can be sent by just typing them in the input
119+
window:</p>
120+
<pre><code>Hows it going?</code></pre>
121+
</section>
122+
<section>
123+
<a name="room-messages"></a>
124+
<h3>Chat rooms</h3>
125+
126+
<p>To join a chat room, use the <a href="reference.html#join"><code>/join</code></a> command:<p>
127+
<pre><code>/join [email protected]</code></pre>
128+
129+
<p>Once a window is opened for the room, messages can be sent by just typing them in the input
130+
window:</p>
131+
<pre><code>Hello everyone</code></pre>
132+
133+
<p>See the chat <a href="rooms.html">Chat room guide</a> for more detail.</p>
134+
</section>
135+
<section>
136+
<a name="managing-contacts"></a>
137+
<h3>Adding contacts</h3>
138+
139+
<p>To add someone to your roster:</p>
140+
<pre><code>/roster add [email protected]</code></pre>
141+
142+
<p>To subscribe to a contacts presence (to be notified when they are online/offline etc):</p>
143+
<pre><code>/sub request [email protected]</code></pre>
144+
145+
<p>To approve a contact's request to subscribe to your presence:</p>
146+
<pre><code>/sub allow [email protected]</code></pre>
147+
148+
<p>See the <a href="reference.html#roster"><code>/roster</code></a> and <a
149+
href="reference.html#sub"><code>/sub</code></a> commands for more detail.</p>
150+
</section>
151+
<section>
152+
<a name="changing-your-presence"></a>
153+
<h3>Changing your presence</h3>
154+
155+
<p>To change your presence, use the following commands:</p>
156+
<pre><code>/status set away
157+
/status set xa
158+
/status set chat
159+
/status set online
160+
/status set dnd</code></pre>
161+
<p>Each of these commands accepts a message as a parameter, so to show the message "I'm very busy" to your
162+
contacts when setting status to Do Not Disturb:</p>
163+
<pre><code>/status set dnd I'm very busy</code></pre>
164+
</section>
165+
<section>
166+
<a name="logging-out"></a>
167+
<h3>Logging out</h3>
168+
169+
<p>To log out from the current chat service:</p>
170+
<pre><code>/disconnect</code></pre>
171+
<p>To quit profanity:</p>
172+
<pre><code>/quit</code></pre>
173+
</section>
174+
</article>
175+
<footer>
176+
<p class="matty">site designed by <a href="http://www.matthewbalaam.co.uk">Matthew Balaam</a></p>
177+
</footer>
178+
</body>
179+
180+
</html>

0 commit comments

Comments
 (0)