aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user-guide/twitter.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user-guide/twitter.xml')
-rw-r--r--doc/user-guide/twitter.xml28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/user-guide/twitter.xml b/doc/user-guide/twitter.xml
new file mode 100644
index 00000000..3827464a
--- /dev/null
+++ b/doc/user-guide/twitter.xml
@@ -0,0 +1,28 @@
+<chapter id="twitter">
+<title>Twitter</title>
+
+<para>
+Twitter allows you to use a set of commands in the Twitter channel/query. See <emphasis>help set commands</emphasis>.
+</para>
+
+<para>
+Anything that doesn't look like a command will be treated as a new message. Watch out for typos, or to avoid this behaviour, set the <emphasis>commands</emphasis> setting to <emphasis>strict</emphasis>, which causes the <emphasis>post</emphasis> command to become mandatory for posting. See <emphasis>help set commands</emphasis>.
+</para>
+
+<para>
+Here is a short description of the commands available:
+<variablelist>
+<varlistentry><term>undo [&lt;#id&gt;]</term><listitem><para>Delete your last message (or one with the given ID)</para></listitem></varlistentry>
+<varlistentry><term>rt &lt;screenname|#id&gt;</term><listitem><para>Retweet someone's last message (or one with the given ID)</para></listitem></varlistentry>
+<varlistentry><term>reply &lt;screenname|#id&gt;</term><listitem><para>Reply to a message (with a reply-to reference)</para></listitem></varlistentry>
+<varlistentry><term>rawreply &lt;screenname|#id&gt;</term><listitem><para>Reply to a message (with no reply-to reference)</para></listitem></varlistentry>
+<varlistentry><term>report &lt;screenname|#id&gt;</term><listitem><para>Report the given user (or the user who posted the message with the given ID) for sending spam. This will also block them.</para></listitem></varlistentry>
+<varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
+<varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
+<varlistentry><term>favourite &lt;screenname|#id&gt;</term><listitem><para>Favo<emphasis>u</emphasis>rite the given user's most recent message, or the given ID.</para></listitem></varlistentry>
+<varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a message</para></listitem></varlistentry>
+<varlistentry><term>url &lt;screenname|#id&gt;</term><listitem><para>Show URL for a message to open it in a browser (and see context)</para></listitem></varlistentry>
+</variablelist>
+</para>
+
+</chapter>