From 361aea1440973839b786cd6ca223c5a39e81410e Mon Sep 17 00:00:00 2001 From: mathieui Date: Wed, 5 Oct 2016 00:26:37 +0200 Subject: Add a quickstart guide --- doc/source/quickstart.rst | 78 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 doc/source/quickstart.rst (limited to 'doc/source/quickstart.rst') diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst new file mode 100644 index 00000000..40e70371 --- /dev/null +++ b/doc/source/quickstart.rst @@ -0,0 +1,78 @@ +Quickstart guide +================ + +This page is an attempt at provinding first aid to new users, who must +first follow the :ref:`Install Guide ` to get a working poezio. + +Reading the more detailed:ref:`Usage page ` is recommended to get +a deeper understanding of poezio. + +Anonymous usage +--------------- + +If you run poezio right after installing, you will get connected to the +default anonymous server, which allows you to join rooms, and talk to people. + +Joining rooms +~~~~~~~~~~~~~ + +The :term:`/join command ` allows you to join a chatroom and start +talking to people right away. It opens a new :ref:`muctab`. + + +Talking to people +~~~~~~~~~~~~~~~~~ + +You can use the :ref:`/message` command if you know the address of people +you want to talk to. This will open a :ref:`conversationtab`. + +Normal usage +------------ + +In order to use an account, you have to edit the :ref:`config` first, +to set the account address and password (optionally). Sadly, poezio doesn’t +allow account creation yet, so if you don’t have an account you will have +to either use another client like gajim_ to create your account, or stay +in anonymous mode. + +After obtaining an account and setting the :term:`jid` config option to +the right value, you should go through the configuration file to get +an overview of the different configuration options available. + +Joining rooms +~~~~~~~~~~~~~ + +Just as in the anonymous mode, the :term:`/join command ` allows you +to join a chatroom and start talking to people right away. It opens a new +:ref:`muctab`. + + +Talking to people +~~~~~~~~~~~~~~~~~ + +Just as in the anonymous mode, you can use the :ref:`/message` command if +you know the address of people you want to talk to. This will open a +:ref:`conversationtab`. + +Adding people +~~~~~~~~~~~~~ + +However, one of the benefits of having an account is to have contacts, see +when they are online and offline, see their activity, mood, etc. To this end, +you should add the people you know to your :ref:`contact list `. + +The :ref:`rostertab` is the tab numbered ``0``, and the only one which is +always open. To add people, use :term:`/add`, to accept a contact request use +:term:`/accept`. + +Using end-to-end encryption +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To use OTR end-to-end encryption, you have to :ref:`enable ` the +:ref:`OTR plugin `. The plugin requires python-potr for python3, so +make sure you have it installed first. + +After that, you can enable the OTR plugin with ``/load otr``. Further usage is +discussed in the :ref:`plugin documentation `. + +.. _gajim: https://gajim.org -- cgit v1.2.3