diff options
author | Geert Hauwaerts <geert@hauwaerts.be> | 2014-07-04 20:38:37 +0200 |
---|---|---|
committer | Geert Hauwaerts <geert@hauwaerts.be> | 2014-07-04 20:38:37 +0200 |
commit | 4c8fe0963c61059cff956ec401ef2cea0091e0fb (patch) | |
tree | f642184544d118641751e2e05cbd2faeba102b5b | |
parent | f295a02cdafff01d7b7161f62bf8a2327fbb10fa (diff) | |
download | irssi-4c8fe0963c61059cff956ec401ef2cea0091e0fb.zip |
Syntax documentation rewrite for F-commands
Rewrote the syntax documentation for all commands starting with the
letter F.
-rw-r--r-- | docs/help/in/flushbuffer.in | 16 | ||||
-rw-r--r-- | docs/help/in/format.in | 24 |
2 files changed, 34 insertions, 6 deletions
diff --git a/docs/help/in/flushbuffer.in b/docs/help/in/flushbuffer.in index c353490a..9b1400b9 100644 --- a/docs/help/in/flushbuffer.in +++ b/docs/help/in/flushbuffer.in @@ -1,6 +1,18 @@ +%9Syntax:%9 + @SYNTAX:flushbuffer@ -If either write_buffer_timeout or write_buffer_size have been set an immediate -write of the buffers is forced. +%9Description:%9 + + Forces an immediate flush of the buffers if the related settings are enabled. + +%9Examples:%9 + + /FLUSHBUFFER + + /SET write_buffer_size + /SET write_buffer_timeout + +%9See also:%9 REDRAW, SCROLLBACK diff --git a/docs/help/in/format.in b/docs/help/in/format.in index ed576c95..2b65a6b6 100644 --- a/docs/help/in/format.in +++ b/docs/help/in/format.in @@ -1,9 +1,25 @@ +%9Syntax:%9 + @SYNTAX:format@ - -reset - -delete +%9Parameters:%9 + + -reset: Restores the original value. + -delete: Removes the format from the configuration. + + The module name, the format name and the value; if no arguments are given, + the list of formats are displayed. + +%9Description:%9 + + Allows you to reconfigure the way messages are displayed. + +%9Examples:%9 + + /FORMAT irc away You have left planet earth + /FORMAT core not_good_idea I'm sorry sir, this broke my irony sensor; add -YES if you really mean it! + /FORMAT -reset irc away -Allows you to view/change irssi's messages. -Use this command with care. +%9See also:%9 RELOAD, SAVE, SET |