summaryrefslogtreecommitdiff
path: root/docs/help/in/set.in
diff options
context:
space:
mode:
Diffstat (limited to 'docs/help/in/set.in')
-rw-r--r--docs/help/in/set.in38
1 files changed, 24 insertions, 14 deletions
diff --git a/docs/help/in/set.in b/docs/help/in/set.in
index e355aaba..1639829a 100644
--- a/docs/help/in/set.in
+++ b/docs/help/in/set.in
@@ -1,23 +1,33 @@
+%9Syntax:%9
+
@SYNTAX:set@
-You can view or change the settings with /SET command.
+%9Parameters:%9
+
+ -clear: Removes the setting's value from the configuration.
+ -default: Restore the setting to its default value.
+
+ The setting and the value; if no value is given, the list of settings that
+ matched will be returned. If no arguments are given, all the settings will
+ be displayed.
-/SET without any arguments displays all the settings.
-/SET <key> displays settings whose key (partly) matches <key>
-/SET <key> <value> sets <key> to <value>
+%9Description:%9
-Boolean settings accept only values ON, OFF and TOGGLE. You can
-also use /TOGGLE command to change them, so /TOGGLE <key> behaves
-like /SET <key> TOGGLE. /TOGGLE also accepts arguments ON and OFF
-when /TOGGLE behaves exactly like /SET.
+ Modifies the value of a setting; boolean settings accept only ON, OFF and
+ TOGGLE.
+
+ Please remember that you need to use the SAVE command to store the changes
+ into your configuration.
-Remember that changes are not saved until you use /SAVE!
+%9Examples:%9
-Examples:
- /SET autolog OFF - Sets value for setting 'autolog'
- /SET close - Shows all settings whose variable name
- contains 'close'. Very practical.
+ /SET
+ /SET nick mike
+ /SET -clear nick
+ /SET log_timestamp %H:%H:%S
+ /SET -default log_timestamp
+ /SET close
-See also: TOGGLE
+%9See also:%9 SAVE, TOGGLE