Mercurial > octave-antonio

comparison scripts/miscellaneous/edit.m @ 20164:df437a52bcaf stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents 002576bbba10
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
20 ## @deftypefn {Command} {} edit @var{name} 20 ## @deftypefn {Command} {} edit @var{name}
21 ## @deftypefnx {Command} {} edit @var{field} @var{value} 21 ## @deftypefnx {Command} {} edit @var{field} @var{value}
22 ## @deftypefnx {Command} {@var{value} =} edit get @var{field} 22 ## @deftypefnx {Command} {@var{value} =} edit get @var{field}
23 ## Edit the named function, or change editor settings. 23 ## Edit the named function, or change editor settings.
24 ## 24 ##
25 ## If @code{edit} is called with the name of a file or function as 25 ## If @code{edit} is called with the name of a file or function as its
26 ## its argument it will be opened in the text editor defined by @env{EDITOR}. 26 ## argument it will be opened in the text editor defined by @env{EDITOR}.
27 ## 27 ##
28 ## @itemize @bullet 28 ## @itemize @bullet
29 ## @item 29 ## @item
30 ## If the function @var{name} is available in a file on your path and 30 ## If the function @var{name} is available in a file on your path and that
31 ## that file is modifiable, then it will be edited in place. If it 31 ## file is modifiable, then it will be edited in place. If it is a system
32 ## is a system function, then it will first be copied to the directory 32 ## function, then it will first be copied to the directory @env{HOME} (see
33 ## @env{HOME} (see below) and then edited. 33 ## below) and then edited. If no file is found, then the m-file variant,
34 ## If no file is found, then the m-file 34 ## ending with @qcode{".m"}, will be considered. If still no file is found,
35 ## variant, ending with ".m", will be considered. If still no file 35 ## then variants with a leading @qcode{"@@"} and then with both a leading
36 ## is found, then variants with a leading "@@" and then with both a 36 ## @qcode{"@@"} and trailing @qcode{".m"} will be considered.
37 ## leading "@@" and trailing ".m" will be considered.
38 ## 37 ##
39 ## @item 38 ## @item
40 ## If @var{name} is the name of a function defined in the interpreter but 39 ## If @var{name} is the name of a function defined in the interpreter but not
41 ## not in an m-file, then an m-file will be created in @env{HOME} 40 ## in an m-file, then an m-file will be created in @env{HOME} to contain that
42 ## to contain that function along with its current definition. 41 ## function along with its current definition.
43 ## 42 ##
44 ## @item 43 ## @item
45 ## If @code{@var{name}.cc} is specified, then it will search for 44 ## If @code{@var{name}.cc} is specified, then it will search for
46 ## @code{@var{name}.cc} in the path and try to modify it, otherwise it will 45 ## @code{@var{name}.cc} in the path and try to modify it, otherwise it will
47 ## create a new @file{.cc} file in the current directory. If @var{name} happens 46 ## create a new @file{.cc} file in the current directory. If @var{name} happens
53 ## the editor will be started with @file{@var{name}.ext} in the current 52 ## the editor will be started with @file{@var{name}.ext} in the current
54 ## directory as the filename. If @file{@var{name}.ext} is not modifiable, 53 ## directory as the filename. If @file{@var{name}.ext} is not modifiable,
55 ## it will be copied to @env{HOME} before editing. 54 ## it will be copied to @env{HOME} before editing.
56 ## 55 ##
57 ## @strong{Warning:} You may need to clear @var{name} before the new definition 56 ## @strong{Warning:} You may need to clear @var{name} before the new definition
58 ## is available. If you are editing a .cc file, you will need 57 ## is available. If you are editing a .cc file, you will need to execute
59 ## to execute @code{mkoctfile @file{@var{name}.cc}} before the definition 58 ## @code{mkoctfile @file{@var{name}.cc}} before the definition will be
60 ## will be available. 59 ## available.
61 ## @end itemize 60 ## @end itemize
62 ## 61 ##
63 ## If @code{edit} is called with @var{field} and @var{value} variables, 62 ## If @code{edit} is called with @var{field} and @var{value} variables, the
64 ## the value of the control field @var{field} will be set to @var{value}. 63 ## value of the control field @var{field} will be set to @var{value}. If an
65 ## If an output argument is requested and the first input argument is @code{get} 64 ## output argument is requested and the first input argument is @code{get}
66 ## then @code{edit} will return the value of the control field @var{field}. 65 ## then @code{edit} will return the value of the control field @var{field}.
67 ## If the control field does not exist, edit will return a structure 66 ## If the control field does not exist, edit will return a structure
68 ## containing all fields and values. Thus, @code{edit get all} returns 67 ## containing all fields and values. Thus, @code{edit get all} returns a
69 ## a complete control structure. 68 ## complete control structure.
69 ##
70 ## The following control fields are used: 70 ## The following control fields are used:
71 ## 71 ##
72 ## @table @samp 72 ## @table @samp
73 ## @item home 73 ## @item home
74 ## This is the location of user local m-files. Be sure it is in your 74 ## This is the location of user local m-files. Be sure it is in your path.
75 ## path. The default is @file{~/octave}. 75 ## The default is @file{~/octave}.
76 ## 76 ##
77 ## @item author 77 ## @item author
78 ## This is the name to put after the "## Author:" field of new functions. 78 ## This is the name to put after the "## Author:" field of new functions. By
79 ## By default it guesses from the @code{gecos} field of the password database. 79 ## default it guesses from the @code{gecos} field of the password database.
80 ## 80 ##
81 ## @item email 81 ## @item email
82 ## This is the e-mail address to list after the name in the author field. 82 ## This is the e-mail address to list after the name in the author field. By
83 ## By default it guesses @code{<$LOGNAME@@$HOSTNAME>}, and if @code{$HOSTNAME} 83 ## default it guesses @code{<$LOGNAME@@$HOSTNAME>}, and if @code{$HOSTNAME}
84 ## is not defined it uses @code{uname -n}. You probably want to override this. 84 ## is not defined it uses @code{uname -n}. You probably want to override
85 ## Be sure to use the format @code{<user@@host>}. 85 ## this. Be sure to use the format @code{@email{user@@host}}.
86 ## 86 ##
87 ## @item license 87 ## @item license
88 ## 88 ##
89 ## @table @samp 89 ## @table @samp
90 ## @item gpl 90 ## @item gpl