summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJon Cairns <jon@joncairns.com>2013-01-28 16:20:19 +0000
committerJon Cairns <jon@ggapps.co.uk>2013-01-28 16:20:19 +0000
commit4a355e9d59f23fbd64e30987c0cc3376e7ba6ffa (patch)
treeded071af8fae90b0c2fde7d38ecfc628b9bd5592 /doc
parent4f6aea6868b722e8d9000e7abfcb317aeae12856 (diff)
downloadvdebug-4a355e9d59f23fbd64e30987c0cc3376e7ba6ffa.zip
Clarify meaning in docs regarding setting of options
Diffstat (limited to 'doc')
-rw-r--r--doc/Vdebug.txt13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/Vdebug.txt b/doc/Vdebug.txt
index 603f30b..15bb31a 100644
--- a/doc/Vdebug.txt
+++ b/doc/Vdebug.txt
@@ -58,7 +58,7 @@ CONTENTS *Vdebug-contents*
4.5.3 Evaluating variable under cursor |VdebugEvalUnderCursor|
5. Options.......................................|VdebugOptions|
5.1 Quickly setting options..................|VdebugOpt|
- 5.2 List of options..........................|VdebugOptions|
+ 5.2 List of options..........................|VdebugOptionList|
6. Key maps......................................|VdebugKeys|
7. Using an IDE key..............................|VdebugIDEKey|
8. Debugging a script on a remote server.........|VdebugRemote|
@@ -744,9 +744,9 @@ some debugger engines.
==============================================================================
5. Options *VdebugOptions*
-As there are a lot of options in Vdebug, they are set using a dictionary
-(the equivalent of an associative array in PHP or a hash in Ruby). This
-dictionary can be modified using the global variable "g:vdebug_options".
+There are two ways of setting options for Vdebug. The options are stored in a
+Vim dictionary (the equivalent of an associative array in PHP or a hash in Ruby).
+This dictionary can be modified using the global variable "g:vdebug_options".
However, as you may want to change options on the fly, a command (:VdebugOpt)
has been added for your convenience so that you can easily get and set options
without having to use Vim dictionary syntax.
@@ -766,9 +766,12 @@ will autocomplete to the current value, if set. Here are some examples: >
:VdebugOpt continuous_mode 0 "Sets to 0
:VdebugOpt debug_file /home/jon/vdebug.log
<
+Note that using :VdebugOpt only sets the value of the option for the time that
+your vim session is open. As soon as you close it they will be forgotten, so
+retain option settings by adding them to your vimrc.
------------------------------------------------------------------------------
-5.2 List of options *VdebugOptions*
+5.2 List of options *VdebugOptionList*
The default options look like this: >
let g:vdebug_options= {