Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-11-22 03:59:31 +01:00
Code Issues Projects Releases Wiki Activity

Update use/faq.rst && add _static/

Browse Source 
* FAQ: make questions titles, so they can be linked more easily
* FAQ: link from question how to identify to Getting Started
* FAQ: add moving from Alias to Aka
* FAQ: change Alias question to be Aka
* FAQ: tell Karma value to be "True" instead of "On"
* _static/: Sphinx was complaining about this directory not existing on
  my local repository.
This commit is contained in:
Mikaela Suomalainen 2014-12-28 09:51:46 +02:00
parent b1e1fb77e9
commit 5044ea2797
2 changed files with 39 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_static/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
# This file is here to stop Sphinx complaining about missing _static
# directory.

49
use/faq.rst
View File

@ -3,11 +3,12 @@ Frequently Asked Questions
**************************
How do I make my Supybot connect to multiple servers?
=====================================================
Just use the `connect` command in the `Network` plugin.
Why does my bot not recognize me or tell me that I don't have the
'owner' capability?
Why does my bot not recognize me or tell me that I don't have the 'owner' capability?
=====================================================================================
Because you've not given it anything to recognize you from!
@ -24,7 +25,11 @@ Why does my bot not recognize me or tell me that I don't have the
course, you should change myOwnerUser and myOwnerUserPassword
appropriately for your bot).
For additional ways to identify to your bot, you may want to see
:ref:`getting-started`.
What is a hostmask?
===================
Each user on IRC is uniquely identified by a string which we call a
`hostmask`. The IRC RFC refers to it as a prefix. Either way, it
@ -34,6 +39,7 @@ What is a hostmask?
components and that they're joined in the appropriate manner.
My bot can't handle nicks with brackets in them!
================================================
It always complains about something not being a valid command, or
about spurious or missing right brackets, etc.
@ -46,24 +52,33 @@ My bot can't handle nicks with brackets in them!
`supybot.commands.nested.brackets` to some other value (like ``<>``,
which can't occur in IRC nicks).
I added an alias, but it doesn't work!
I loaded Alias before, how do I move to Aka?
============================================
Take a look at ``help <alias you added>``. If the alias the bot has
First load both of the plugins, Aka and Alias. Then run
``aka importaliasdatabase`` and ``unload Alias``. Now all your aliases
should be imported to the Aka plugin.
I added an aka, but it doesn't work!
====================================
Take a look at ``aka show <aka you added>``. If the aka the bot has
listed doesn't match what you're giving it, chances are you need to
quote your alias in order for the brackets not to be evaluated. For
instance, if you're adding an alias to give you a link to your
quote your aka in order for the brackets not to be evaluated. For
instance, if you're adding an aka to give you a link to your
homepage, you need to say::
alias add mylink "format concat http://my.host.com/ [urlquote $1]"
aka add mylink "format concat http://my.host.com/ [urlquote $1]"
and not::
alias add mylink format concat http://my.host.com/ [urlquote $1]
aka add mylink format concat http://my.host.com/ [urlquote $1]
The first version works; the second version will always return the
same url.
What does 'lobotomized' mean?
=============================
I see this word in commands and in my `channels.conf`, but I don't
know what it means. What does Supybot mean when it says "lobotomized"?
@ -80,6 +95,7 @@ What does 'lobotomized' mean?
as possible.
Is there a way to load all the plugins Supybot has?
===================================================
No, there isn't. Even if there were, some plugins conflict with other
plugins, so it wouldn't make much sense to load them. For instance,
@ -89,8 +105,8 @@ Is there a way to load all the plugins Supybot has?
If you want to know more about the plugins that are available, check
out our `plugin index`_ at our `website`_.
Is there a command that can tell me what capability another command
requires?
Is there a command that can tell me what capability another command requires?
=============================================================================
No, there isn't, and there probably never will be.
@ -103,14 +119,16 @@ requires?
add this partial solution.
Why doesn't `Karma` seem to work for me?
========================================
`Karma`, by default, doesn't acknowledge karma updates. If you check
the karma of whatever you increased/decreased, you'll note that your
increment or decrement still took place. If you'd rather `Karma`
acknowledge karma updates, change the `supybot.plugins.Karma.response`
configuration variable to "On".
configuration variable to "True".
Why won't Supybot respond to private messages?
==============================================
The most likely cause is that you are running your bot on the Freenode
network. Around Sept. 2005, Freenode added a user mode which
@ -125,6 +143,7 @@ Why won't Supybot respond to private messages?
registered, and your Supybot has the +R user mode set.
Can users with the "admin" capability change configuration?
===========================================================
Currently, no. Feel free to make your case to us as to why a certain
configuration variable should only require the `admin` capability
@ -132,11 +151,13 @@ Can users with the "admin" capability change configuration?
change it for the next release.
How can I make my Supybot log my IRC channel?
=============================================
To log all the channels your Supybot is in, simply load the
`ChannelLogger` plugin, which is included in the main distribution.
How do I find out channel modes?
================================
I want to know who's an op in a certain channel, or who's voiced, or
what the modes on the channel are. How do I do that?
@ -155,6 +176,7 @@ How do I find out channel modes?
From there, things should be self-evident.
Can Supybot connect through a proxy server?
===========================================
Limnoria can connect to specific network using socks proxy, simply set
the configuration variable `supybot.networks.<network>.socksproxy`. For
@ -166,6 +188,7 @@ Can Supybot connect through a proxy server?
does work with these.
Why can't Supybot find the plugin I want to load?
=================================================
Why does my bot say that 'No plugin "foo" exists.' when I try to load
the foo plugin?
@ -179,10 +202,12 @@ Why can't Supybot find the plugin I want to load?
makes a difference to Python.
I've found a bug, what do I do?
===============================
Submit your bug at our `issue tracker`_.
Is Python installed?
====================
I run Windows, and I'm not sure if Python is installed on my computer.
How can I find out for sure?
@ -200,5 +225,5 @@ Is Python installed?
.. _website: http://supybot.com/
.. _blocks: http://freenode.net/faq.shtml#blockingmessages
.. _tsocks: http://tsocks.sourceforge.net
.. _issue_tracker: https://github.com/ProgVal/Limnoria/issues
.. _issue tracker: https://github.com/ProgVal/Limnoria/issues
.. _download it: http://python.org/download/