view doc/html/guide/05-irccdctl/02-usage.md @ 13:070a1ece2af6

Docs: fix various errors in JavaScript API
author David Demelier <markand@malikania.fr>
date Thu, 11 Feb 2016 22:02:57 +0100
parents 1158cffe5a5e
children 8384df86e195
line wrap: on
line source

## Usage

Usage of irccdctl.

### Syntax

The general syntax for running an irccdctl command is:

````
irccdctl commandname arg1 arg2 arg3 ... argn
````

You can have the online documentation by typing `irccdctl help commandname`.

### Shell escaping issue

Some shells may discard arguments if they begins with a hash. For instance, `bash` will not understand the following
command:

````
$ irccdctl server-join localhost #staff
````

Instead, enclose the arguments with quotes

````
$ irccdctl server-join localhost "#staff"
````