Mercurial > irccd

annotate doc/html/irccdctl/usage.md @ 306:c6eed76f8646

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Tests: add test for server-invite, #559
author David Demelier <markand@malikania.fr>
date Wed, 19 Oct 2016 17:55:49 +0200
parents 904ee87bc808
children a60142be369a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
260
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 title: Irccdctl usage and options
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 guide: yes
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 ---
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 ## Usage
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 Usage of irccdctl.
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 ### Syntax
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 The general syntax for running an irccdctl command is:
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
13
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 ````nohighlight
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 irccdctl commandname arg1 arg2 arg3 ... argn
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 ````
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 You can have the online documentation by typing `irccdctl help commandname`.
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 ### Shell escaping issue
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 Some shells may discard arguments if they begins with a hash. For instance, `bash` will not understand the following
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 command:
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 ````nohighlight
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 $ irccdctl server-join localhost #staff
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 ````
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 Instead, enclose the arguments with quotes
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 ````nohighlight
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 $ irccdctl server-join localhost "#staff"
904ee87bc808 CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 ````