From 0b84c879d4de48eda35d9f33bfe044b547fe8407 Mon Sep 17 00:00:00 2001 From: jesopo Date: Mon, 15 Apr 2019 17:04:43 +0100 Subject: [PATCH] Replace "<" with "<" --- docs/help/setup.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/help/setup.md b/docs/help/setup.md index 9527e711..c84b7367 100644 --- a/docs/help/setup.md +++ b/docs/help/setup.md @@ -5,9 +5,9 @@ * Run `./start.py -m permissions -M master-password` to get the master admin password (needed to add regular admin accounts) * Run `./start.py` to start the bot. * Join `#bitbot` on a server with the bot (or invite it to another channel) -* `/msg register ` to register your nickname with the bot -* `/msg masterlogin ` to login as master admin -* `/msg givepermission *` to give your account admin permissions +* `/msg <bot> register <password here>` to register your nickname with the bot +* `/msg <bot> masterlogin <master admin password>` to login as master admin +* `/msg <bot> givepermission <your nickname> *` to give your account admin permissions ### Configure client TLS certificate @@ -19,34 +19,34 @@ Configure the bot to use SASL to authenticate (usually used for `NickServ` ident `EXTERNAL` usually mean client TLS certificate authentication; `USERPASS` is a BitBot-specific term that selects the strongest user/password algorithm. -> /msg config server sasl userpass <username>:<password> +> /msg <bot> config server sasl userpass <username>:<password> -> /msg config server sasl plain <username>:<password> +> /msg <bot> config server sasl plain <username>:<password> -> /msg config server sasl scram-sha-1 <username>:<password> +> /msg <bot> config server sasl scram-sha-1 <username>:<password> -> /msg config server sasl scram-sha-256 <username>:<password> +> /msg <bot> config server sasl scram-sha-256 <username>:<password> -> /msg config server sasl external +> /msg <bot> config server sasl external ### Commands on-connect -The `perform.py` module allows the bot to execute a saved list of raw IRC commands against a server it's connecting to. Use `/msg performadd ` to add to the current server's list of commands (`%nick%` in a raw command will be replaced with the bot's current nick.) +The `perform.py` module allows the bot to execute a saved list of raw IRC commands against a server it's connecting to. Use `/msg <bot> performadd <raw irc command>` to add to the current server's list of commands (`%nick%` in a raw command will be replaced with the bot's current nick.) ### Config options #### View available config options -> /msg config bot|server|channel|user +> /msg <bot> config bot|server|channel|user #### Set config options -> /msg config bot +> /msg <bot> config bot <setting> <value> -> /msg config server +> /msg <bot> config server <setting> <value> -> /msg config channel:#bitbot +> /msg <bot> config channel:#bitbot <setting> <value> -> /msg config user +> /msg <bot> config user <setting> <value> -> /msg config user:other_user +> /msg <bot> config user:other_user <setting> <value>