diff options
author | mathieui <mathieui@mathieui.net> | 2013-04-13 22:33:06 +0200 |
---|---|---|
committer | mathieui <mathieui@mathieui.net> | 2013-04-13 22:33:06 +0200 |
commit | d676c2ee7b6207ff0b2a7b384052ab07c08bf43a (patch) | |
tree | b6c22d35da1eb5bc33ab0cc983a86d8dfe6c2a78 /plugins/exec.py | |
parent | e6cb43eeedcd6c6961c5ab430f25bb962d40bf8e (diff) | |
download | poezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.tar.gz poezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.tar.bz2 poezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.tar.xz poezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.zip |
Move the plugins documentation
(use automodule directive & docstrings)
Diffstat (limited to 'plugins/exec.py')
-rw-r--r-- | plugins/exec.py | 44 |
1 files changed, 43 insertions, 1 deletions
diff --git a/plugins/exec.py b/plugins/exec.py index 4dbe9590..10681713 100644 --- a/plugins/exec.py +++ b/plugins/exec.py @@ -1,4 +1,46 @@ -# A plugin that can execute a command and send the result in the conversation +""" +This plugin lets you execute a system command through poezio. + +Installation +------------ + +You only have to load the plugin. :: + + /load exec + +Usage +----- + +.. warning:: Running commands that start a daemon or an interface is not a good + idea. + +.. glossary:: + + /exec + **Usage:** ``/exec [-o|-O] <command>`` + + Execute a system command. + + :: + + /exec command + + Will give you the result in the information buffer. + + :: + + /exec -o command + + Will send the result of the command into the current tab, if possible. + + :: + + /exec -O command + + Will send the result of the command and the command summary into the current + tab, if possible. + +""" from plugin import BasePlugin import os |