transpub/USAGE.rst

108 lines
3.4 KiB
ReStructuredText
Raw Normal View History

Usage
=====
Starting/stopping service
-------------------------
The ``transwhat.py`` script gets started as a backend by Spectrum. You
should not try to run it manually. To simplify the management of
multiple transports (WhatsApp, IRC, Facebook, libpurple, …), Spectrum
provides a little helper tool called ``spectrum_manager``:
To start transwhat run
::
spectrum_manager start whatsapp
To stop transwhat run
::
spectrum_manager stop whatsapp
Bot
---
You might want to talk to bot if youre feeling lonely ;-P
The bot is one of the contacts every user has in its contact list. It
offers you a simple way to interact with the server:
+------------------+--------------------------------------------+
| **Command** | **Description** |
+==================+============================================+
| ``\help`` | show this message |
+------------------+--------------------------------------------+
| ``\prune`` | clear your buddylist |
+------------------+--------------------------------------------+
| ``\lastseen`` | request last online timestamp from buddy |
+------------------+--------------------------------------------+
| ``\leave`` | permanently leave group chat |
+------------------+--------------------------------------------+
| ``\groups`` | print all attended groups |
+------------------+--------------------------------------------+
| ``\getgroups`` | get current groups from WA |
+------------------+--------------------------------------------+
.. raw:: html
<note tip>
All commands start with a **back**\ slash!
.. raw:: html
</note>
Login
-----
To login to the transWhat, you should use the service discovery option
in your XMPP client.
When asked about the login credentials, enter your data as described
below:
+---------------+-----------------------------+----------------------+
| **Setting** | **Value** | **Example** |
+===============+=============================+======================+
| User | CountryCode + PhoneNumber | 4917634911387 |
+---------------+-----------------------------+----------------------+
| Password | WhatsApp password | `*Base64 string*`_ |
+---------------+-----------------------------+----------------------+
Buddies
~~~~~~~
WhatsApp does not store your contacts on their servers. Thus you need to
import your contacts manually with your XMPP Client or use [[.:bot\|our
bot]] to Import your contacts from Google (preferred).
(In Pidgin: Menu => Buddys => Add Buddy)
Just use the same JID format as for your login:
CountryCode + PhoneNumber + “@whatsapp.example.org”
Groups
~~~~~~
To chat with groups you need to add them manually to your XMPP client.
To get a list of your WhatsApp groups, you can use the Auto Discovery
functionality of your XMPP client.
(In Pidgin: Menu => Buddys => Join Chat => RoomList)
Smileys / Emojis
~~~~~~~~~~~~~~~~
To be able to see smileys, you will need an `Unicode Emoji font`_.
When using Pidgin, you might want to check out my `stv0gs Unicode emoji
theme`_].
.. _*Base64 string*: https://github.com/davidgfnet/whatsapp-purple#how-do-i-get-my-user-name-and-password
.. _Unicode Emoji font: https://github.com/stv0g/unicode-emoji/raw/master/symbola/Symbola.ttf
.. _stv0gs Unicode emoji theme: https://github.com/stv0g/unicode-emoji