Initial commit

src/content/docs/getting-started/quick-start.md

@@ -0,0 +1,221 @@
+---
+title: Quick Start
+description: A console-based XMPP client for power users.
+sidebar:
+  order: 3
+---
+
+## Starting CProof
+
+<br />
+
+To start CProof, run the following at the command line:
+
+```bash
+$ profanity
+```
+
+To see options available to the command:
+
+```bash
+$ profanity -h
+```
+
+## User Interface
+
+![CProof User Interface](@assets/CProof-ui-1.png)
+
+The user interface is split into four main areas:
+
+### Title bar
+
+![CProof User Interface](@assets/CProof-ui-2.png)
+
+Shows the title for the current window (usually the contact you are chatting with, or the chat room you have joined), and your current presence.
+
+### Main window area
+
+![CProof User Interface](@assets/CProof-ui-3.png)
+
+Used to show the current active window. The first window (1) is reserved for the 'console' where system messages and command responses are shown.
+
+### Status bar
+
+![CProof User Interface](@assets/CProof-ui-4.png)
+
+Shows the time, the user you are logged in as, and status of each window. If a window is used, its number will appear, if it has new messages of any kind, the number will be highlighted. The current window is shown as -1-.
+
+### Input area
+
+![CProof User Interface](@assets/CProof-ui-5.png)
+
+Where commands and messages are entered. Commands and command arguments can be autocompleted with the tab key.
+
+All commands start with a / character e.g.:
+
+```bash
+/help
+```
+
+## Account setup
+
+### Registration
+
+To use CProof, you first need to register a JID (Jabber ID) and then add your account.
+
+If you don’t have a JID yet, use the [`/register`](/command-reference/#register) command to create one. If you already have a JID, you can skip this step.
+
+```bash
+/register nickname example.com
+```
+
+Once you have your JID, add your account in CProof with the [`/account add`](/command-reference/#account) command followed by a name for your account. For example:
+
+```bash
+/account add main_account
+```
+
+Next, set your JID and password for this account:
+
+```bash
+/account set main_account jid your_account_name@example.com  
+/account set main_account password MySecurePassword
+```
+
+Finally, connect to your account using the [`/connect`](/command-reference/#connect) command:
+
+```bash
+/connect main_account
+```
+
+To make it easier for yourself in the future, add autoconnect to this account. It will ensure that you are automatically connected to that account on each login:
+```bash
+/autoconnect set main_account
+```
+
+
+## Window Navigation
+
+To make a window visible in the main window area, use any of the following:
+
+`Alt-1` to `Alt-0`
+
+`F1` to `F10`
+
+`Alt-Left`,`Alt-Right`
+
+The [`/win`](/command-reference#win) command may also be used. Either the window number may be passed, or the window title:
+
+```bash
+/win 4
+/win someroom@chatserver.org
+/win MyBuddy
+```
+
+To close the current window:
+
+```bash
+/close
+```
+
+## Connecting
+
+To connect to an XMPP chat service:
+
+```bash
+/connect user@server.com
+```
+
+You will be prompted by the status bar to enter your password.
+
+See the [`/connect`](/command-reference#connect) command for additional arguments that may be used when connecting.
+
+## One to one chat
+
+To open a new window and send a message use the [`/msg`](/command-reference#msg) command:
+
+```bash
+/msg mycontact@server.com Hello there!
+```
+
+CProof uses the contact's nickname by default, if one exists. For example:
+
+```bash
+/msg Bob Are you there bob?
+```
+
+Once a window is opened with the contact, messages can be sent by just typing them in the input window:
+
+```plaintext
+Hows it going?
+```
+
+## Chat rooms
+
+To join a chat room, use the [`/join`](/command-reference#join) command:
+
+```bash
+/join room@server.org
+```
+
+Once a window is opened for the room, messages can be sent by just typing them in the input window:
+
+```plaintext
+Hello everyone
+```
+
+See the chat [`Chat room guide`](/guides/chat-rooms) for more detail.
+
+## Adding contacts
+
+To add someone to your roster:
+
+```bash
+/roster add newfriend@server.chat.com
+```
+
+To subscribe to a contacts presence (to be notified when they are online/offline etc):
+
+```bash
+/sub request newfriend@server.chat.com
+```
+
+To approve a contact's request to subscribe to your presence:
+
+```bash
+/sub allow newfriend@server.chat.com
+```
+
+See the [`/roster`](/command-reference#roster) and [`/sub`](/command-reference#sub) commands for more detail.
+
+## Changing your presence
+
+To change your presence, use the following commands:
+
+```bash
+/status set away
+/status set xa
+/status set chat
+/status set online
+/status set dnd
+```
+
+Each of these commands accepts a message as a parameter, so to show the message "I'm very busy" to your contacts when setting status to Do Not Disturb:
+
+```bash
+/status set dnd I'm very busy
+```
+
+## Logging out
+
+To log out from the current chat service:
+
+```bash
+/disconnect
+```
+
+To quit CProof:
+
+```bash
+/quit
+```