diff options
| author | Tom Feist <shabble@cowu.be> | 2010-07-21 17:07:50 +0000 |
|---|---|---|
| committer | Tom Feist <shabble@cowu.be> | 2010-07-21 17:07:50 +0000 |
| commit | 440f9d752fa43726ac73e4482994e73417ec8de9 (patch) | |
| tree | fe123238d1268c5dcf6a4b5858cb40f818dd770d /docs/Irssi | |
| parent | added some stuff to the guide, and cleaned up some irssi.pod function descs (diff) | |
| download | irssi-scripts-440f9d752fa43726ac73e4482994e73417ec8de9.tar.gz irssi-scripts-440f9d752fa43726ac73e4482994e73417ec8de9.zip | |
stubbed out empty files, mroe content in Guide
Diffstat (limited to '')
| -rw-r--r-- | docs/Irssi.pod | 42 | ||||
| -rw-r--r-- | docs/Irssi/TextUI/Line.pod | 3 | ||||
| -rw-r--r-- | docs/Irssi/TextUI/LineCache.pod | 3 | ||||
| -rw-r--r-- | docs/Irssi/TextUI/LineInfo.pod | 3 | ||||
| -rw-r--r-- | docs/Irssi/TextUI/MainWindow.pod | 3 | ||||
| -rw-r--r-- | docs/Irssi/TextUI/StatusbarItem.pod | 3 | ||||
| -rw-r--r-- | docs/Irssi/TextUI/TextBufferView.pod | 3 | ||||
| -rw-r--r-- | docs/Irssi/TextUI/Textbuffer.pod | 3 |
8 files changed, 63 insertions, 0 deletions
diff --git a/docs/Irssi.pod b/docs/Irssi.pod index 97e4799..d67b9aa 100644 --- a/docs/Irssi.pod +++ b/docs/Irssi.pod @@ -404,6 +404,48 @@ using one of the C<settings_add> functions. =head4 C<settings_add_size $section, $key, $def> +Each of the above functions operates in the same way, but creates a different +data type. For each function, C<$section> is a string describing the +group the entry falls into, C<$key> is the name of the setting. The key must +be a single string, and typically multiple words are separated by underscores. + +The final parameter, C<$def>, is the default value of this setting. It should +correspond to the type of the setting being created. + +B<TODO: move this list to another section?> + +The following list summarises the data types available: + +=over + +=item C<str> + +A generic string type, which can contain arbitrary text. It is also commonly +used to build space-separated lists of entries. + +=item C<int> + +An integer type. Integers must be whole numbers, but may also be negative or zero. + +=item C<bool> + +A boolean type. In Perl terms, values are C<0> for false, and anything else for +true. When acting on them externally, C<ON> and C<OFF> are the usual terms used. + +=item C<time> + +A time type. B<TODO: what values can it take?> + +=item C<level> + +An irssi Messagelevel. See C</HELP LEVELS> for a full list and description. + +=item C<size> + +B<TODO: What is this for?> + +=back + =head3 Retrieving Settings =head4 C<settings_get_str $key> diff --git a/docs/Irssi/TextUI/Line.pod b/docs/Irssi/TextUI/Line.pod index e69de29..08bdae1 100644 --- a/docs/Irssi/TextUI/Line.pod +++ b/docs/Irssi/TextUI/Line.pod @@ -0,0 +1,3 @@ +__END__ + +=head1 Empty diff --git a/docs/Irssi/TextUI/LineCache.pod b/docs/Irssi/TextUI/LineCache.pod index e69de29..08bdae1 100644 --- a/docs/Irssi/TextUI/LineCache.pod +++ b/docs/Irssi/TextUI/LineCache.pod @@ -0,0 +1,3 @@ +__END__ + +=head1 Empty diff --git a/docs/Irssi/TextUI/LineInfo.pod b/docs/Irssi/TextUI/LineInfo.pod index e69de29..08bdae1 100644 --- a/docs/Irssi/TextUI/LineInfo.pod +++ b/docs/Irssi/TextUI/LineInfo.pod @@ -0,0 +1,3 @@ +__END__ + +=head1 Empty diff --git a/docs/Irssi/TextUI/MainWindow.pod b/docs/Irssi/TextUI/MainWindow.pod index e69de29..08bdae1 100644 --- a/docs/Irssi/TextUI/MainWindow.pod +++ b/docs/Irssi/TextUI/MainWindow.pod @@ -0,0 +1,3 @@ +__END__ + +=head1 Empty diff --git a/docs/Irssi/TextUI/StatusbarItem.pod b/docs/Irssi/TextUI/StatusbarItem.pod index e69de29..08bdae1 100644 --- a/docs/Irssi/TextUI/StatusbarItem.pod +++ b/docs/Irssi/TextUI/StatusbarItem.pod @@ -0,0 +1,3 @@ +__END__ + +=head1 Empty diff --git a/docs/Irssi/TextUI/TextBufferView.pod b/docs/Irssi/TextUI/TextBufferView.pod index e69de29..08bdae1 100644 --- a/docs/Irssi/TextUI/TextBufferView.pod +++ b/docs/Irssi/TextUI/TextBufferView.pod @@ -0,0 +1,3 @@ +__END__ + +=head1 Empty diff --git a/docs/Irssi/TextUI/Textbuffer.pod b/docs/Irssi/TextUI/Textbuffer.pod index e69de29..08bdae1 100644 --- a/docs/Irssi/TextUI/Textbuffer.pod +++ b/docs/Irssi/TextUI/Textbuffer.pod @@ -0,0 +1,3 @@ +__END__ + +=head1 Empty |