Browse Source

README: add note about config file

Also:
- update usage message
- kaabot.py: update description (period needed after the description,
  because of ConfigArgParse automatic message).
master
Matteo Cypriani 3 years ago
parent
commit
43e04dc62d
2 changed files with 6 additions and 4 deletions
  1. +5
    -3
      README.md
  2. +1
    -1
      kaabot.py

+ 5
- 3
README.md View File

@@ -29,6 +29,9 @@ mkdir $HOME/.config/kaabot
cp vocabulary.json $HOME/.config/kaabot
```

If no configuration file exists, one will be created automatically (typically
in `$HOME/.config/kaabot/config`) when KaaBot is launched for the first time.

Usage
-----

@@ -40,7 +43,7 @@ optional arguments:
-h, --help show this help message and exit
-d, --debug set logging to DEBUG
-b DATABASE, --database DATABASE
path to an alternative database; the "{muc}" string in
path to an alternative database; the '{muc}' string in
the name will be substituted with the MUC's name as
provided by the --muc option
-j JID, --jid JID JID to use
@@ -48,9 +51,8 @@ optional arguments:
password to use
-m MUC, --muc MUC Multi User Chatroom to join
-n NICK, --nick NICK nickname to use in the chatroom (default: KaaBot)
-V VOCABULARY_FILE, --vocabulary VOCABULARY_FILE
-V VOCABULARY_FILE, --vocabulary_file VOCABULARY_FILE
path to an alternative vocabulary file
```

License


+ 1
- 1
kaabot.py View File

@@ -385,7 +385,7 @@ if __name__ == '__main__':
config_file = os.path.join(config_dir, 'config')

argp = configargparse.ArgParser(default_config_files=[config_file],
description="Super Simple Silly Bot for Jabber")
description="Super Simple Silly Bot for Jabber.")
argp.add_argument('-d', '--debug', help="set logging to DEBUG",
action='store_const',
dest='debug', const=logging.DEBUG,


Loading…
Cancel
Save