Mercurial > octave-nkf
diff scripts/miscellaneous/edit.m @ 8795:bb38a86efa1b
improve documentation for edit.m
author | Ivan Sutoris <ivan.sutoris@gmail.com> |
---|---|
date | Wed, 18 Feb 2009 01:31:14 -0500 |
parents | 5dd06f19e9be |
children | eb63fbe60fab |
line wrap: on
line diff
--- a/scripts/miscellaneous/edit.m Wed Feb 18 01:10:43 2009 -0500 +++ b/scripts/miscellaneous/edit.m Wed Feb 18 01:31:14 2009 -0500 @@ -83,6 +83,8 @@ ## Send it to current Emacs; must have @code{(gnuserv-start)} in @file{.emacs}. ## @end table ## +## See also field 'mode', which controls how the editor is run by Octave. +## ## On cygwin, you will need to convert the cygwin path to a windows ## path if you are using a native Windows editor. For example ## @example @@ -120,8 +122,9 @@ ## ## @item mode ## This value determines whether the editor should be started in async mode -## or sync mode. Set it to "async" to start the editor in async mode. The -## default is "sync" (see also "system"). +## (editor is started in the background and Octave continues) or sync mode +## (Octave waits until the editor exits). Set it to "async" to start the editor +## in async mode. The default is "sync" (see also "system"). ## ## @item editinplace ## Determines whether files should be edited in place, without regard to