Commit 4ad066b3 authored by mathieui's avatar mathieui

Documentation update

parent 3a608c19
......@@ -13,10 +13,10 @@ As far as I know, Poezio is available in the following distributions, you just
have to install it by using the package manager of the distribution, if you're
using one of these.
- **Archlinux**: A poezio_ and poezio-git_ packages are in AUR (use your favourite
AUR wrapper to install them)
- **Gentoo**: `Sekhs overlay`_ contains everything required to build stable
versions of poezio (sleekxmpp, dnspython, and poezio)
- **Archlinux**: poezio_ and poezio-git_ packages are in the AUR
(use your favourite AUR wrapper to install them)
- **Gentoo**: Its uncertain, but the bgo-overlay_ appears to contain poezio
and slixmpp packages.
- **Fedora**: The stable poezio package was out of date for a long time in
Fedora, but now thanks to Casper, there is an `up-to-date package`_ in
the repos since F19.
......@@ -26,6 +26,7 @@ using one of these.
- **Nix** (and **NixOS**): The last stable version of poezio is availalble in
the unstable branch of `nixpkgs`. Use ``nix-env -f "<nixpkgs>" -iA poezio``
to install poezio for the current user.
- **OpenBSD**: a poezio port_ is available
(If another distribution provides a poezio package, please tell us and we will
add it to the list)
......@@ -194,7 +195,6 @@ If you did, it should be in the ``$PATH`` as ``poezio``, so run:
poezio
.. _Sekhs overlay: https://github.com/sekh/sekh_overlay
.. _stable sources: https://dev.louiz.org/project/poezio/download
.. _slixmpp: https://dev.louiz.org/projects/slixmpp
.. _aiodns: https://github.com/saghul/aiodns
......@@ -204,4 +204,5 @@ If you did, it should be in the ``$PATH`` as ``poezio``, so run:
.. _pypi: https://pypi.python.org/pypi/poezio
.. _development builds: http://dédié.jeproteste.info/poezio_debian/
.. _cython: http://cython.org
.. _bgo-overlay: https://bgo.zugaina.org/
.. _port: http://ports.su/net/poezio
Quickstart guide
================
This page is an attempt at provinding first aid to new users, who must
first follow the :ref:`Install Guide <install>` to get a working poezio.
This page is an attempt at providing first aid to new users, who must
first follow the :ref:`Install Guide <install>` to get a working poezio
install.
Reading the more detailed:ref:`Usage page <usage>` is recommended to get
Reading the more detailed :ref:`Usage page <usage>` is recommended to get
a deeper understanding of poezio.
Anonymous usage
......@@ -23,7 +24,7 @@ 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 can use the :term:`/message` command if you know the address of people
you want to talk to. This will open a :ref:`conversationtab`.
Normal usage
......@@ -37,7 +38,9 @@ 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.
an overview of the different :ref:`configuration options <config>` available. If you
don’t set the value of the :term:`password` option, you will be prompted
to enter it on startup.
Joining rooms
~~~~~~~~~~~~~
......@@ -50,7 +53,7 @@ to join a chatroom and start talking to people right away. It opens a new
Talking to people
~~~~~~~~~~~~~~~~~
Just as in the anonymous mode, you can use the :ref:`/message` command if
Just as in the anonymous mode, you can use the :term:`/message` command if
you know the address of people you want to talk to. This will open a
:ref:`conversationtab`.
......@@ -75,4 +78,10 @@ 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 <otr-plugin>`.
Exiting poezio
~~~~~~~~~~~~~~
Use the :term:`/exit` command to quit poezio.
.. _gajim: https://gajim.org
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment