comparison src/dirfns.cc @ 10840:89f4d7e294cc

Grammarcheck .cc files
author Rik <octave@nomad.inbox5.com>
date Sat, 31 Jul 2010 11:18:11 -0700
parents 3140cb7a05a1
children fd0a3ac60b0e
comparison
equal deleted inserted replaced
10839:65bc065bec95 10840:89f4d7e294cc
99 @example\n\ 99 @example\n\
100 cd ~/octave\n\ 100 cd ~/octave\n\
101 @end example\n\ 101 @end example\n\
102 \n\ 102 \n\
103 @noindent\n\ 103 @noindent\n\
104 Changes the current working directory to @file{~/octave}. If the\n\ 104 changes the current working directory to @file{~/octave}. If the\n\
105 directory does not exist, an error message is printed and the working\n\ 105 directory does not exist, an error message is printed and the working\n\
106 directory is not changed.\n\ 106 directory is not changed.\n\
107 @seealso{mkdir, rmdir, dir}\n\ 107 @seealso{mkdir, rmdir, dir}\n\
108 @end deffn") 108 @end deffn")
109 { 109 {
198 // FIXME -- should maybe also allow second arg to specify 198 // FIXME -- should maybe also allow second arg to specify
199 // mode? OTOH, that might cause trouble with compatibility later... 199 // mode? OTOH, that might cause trouble with compatibility later...
200 200
201 DEFUNX ("mkdir", Fmkdir, args, , 201 DEFUNX ("mkdir", Fmkdir, args, ,
202 "-*- texinfo -*-\n\ 202 "-*- texinfo -*-\n\
203 @deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{dir})\n\ 203 @deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{dir})\n\
204 @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{parent}, @var{dir})\n\ 204 @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{parent}, @var{dir})\n\
205 Create a directory named @var{dir} in the directory @var{parent}.\n\ 205 Create a directory named @var{dir} in the directory @var{parent}.\n\
206 \n\ 206 \n\
207 If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty\n\ 207 If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty\n\
208 character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\ 208 character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\
281 return retval; 281 return retval;
282 } 282 }
283 283
284 DEFUNX ("rmdir", Frmdir, args, , 284 DEFUNX ("rmdir", Frmdir, args, ,
285 "-*- texinfo -*-\n\ 285 "-*- texinfo -*-\n\
286 @deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir})\n\ 286 @deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir})\n\
287 @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir}, @code{\"s\"})\n\ 287 @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir}, @code{\"s\"})\n\
288 Remove the directory named @var{dir}.\n\ 288 Remove the directory named @var{dir}.\n\
289 \n\ 289 \n\
290 If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty\n\ 290 If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty\n\
291 character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\ 291 character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\
552 @table @code\n\ 552 @table @code\n\
553 @itemx *\n\ 553 @itemx *\n\
554 matches any string, including the null string,\n\ 554 matches any string, including the null string,\n\
555 @itemx ?\n\ 555 @itemx ?\n\
556 matches any single character, and\n\ 556 matches any single character, and\n\
557 \n\
557 @item [@dots{}]\n\ 558 @item [@dots{}]\n\
558 matches any of the enclosed characters.\n\ 559 matches any of the enclosed characters.\n\
559 @end table\n\ 560 @end table\n\
560 \n\ 561 \n\
561 Tilde expansion\n\ 562 Tilde expansion\n\
644 DEFUN (fnmatch, args, , 645 DEFUN (fnmatch, args, ,
645 "-*- texinfo -*-\n\ 646 "-*- texinfo -*-\n\
646 @deftypefn {Built-in Function} {} fnmatch (@var{pattern}, @var{string})\n\ 647 @deftypefn {Built-in Function} {} fnmatch (@var{pattern}, @var{string})\n\
647 Return 1 or zero for each element of @var{string} that matches any of\n\ 648 Return 1 or zero for each element of @var{string} that matches any of\n\
648 the elements of the string array @var{pattern}, using the rules of\n\ 649 the elements of the string array @var{pattern}, using the rules of\n\
649 filename pattern matching. For example,\n\ 650 filename pattern matching. For example:\n\
650 \n\ 651 \n\
651 @example\n\ 652 @example\n\
652 @group\n\ 653 @group\n\
653 fnmatch (\"a*b\", @{\"ab\"; \"axyzb\"; \"xyzab\"@})\n\ 654 fnmatch (\"a*b\", @{\"ab\"; \"axyzb\"; \"xyzab\"@})\n\
654 @result{} [ 1; 1; 0 ]\n\ 655 @result{} [ 1; 1; 0 ]\n\
678 return retval; 679 return retval;
679 } 680 }
680 681
681 DEFUN (filesep, args, , 682 DEFUN (filesep, args, ,
682 "-*- texinfo -*-\n\ 683 "-*- texinfo -*-\n\
683 @deftypefn {Built-in Function} {} filesep ()\n\ 684 @deftypefn {Built-in Function} {} filesep ()\n\
684 @deftypefnx {Built-in Function} {} filesep ('all')\n\ 685 @deftypefnx {Built-in Function} {} filesep ('all')\n\
685 Return the system-dependent character used to separate directory names.\n\ 686 Return the system-dependent character used to separate directory names.\n\
686 \n\ 687 \n\
687 If 'all' is given, the function return all valid file separators in\n\ 688 If 'all' is given, the function return all valid file separators in\n\
688 the form of a string. The list of file separators is system-dependent.\n\ 689 the form of a string. The list of file separators is system-dependent.\n\
715 return retval; 716 return retval;
716 } 717 }
717 718
718 DEFUN (pathsep, args, nargout, 719 DEFUN (pathsep, args, nargout,
719 "-*- texinfo -*-\n\ 720 "-*- texinfo -*-\n\
720 @deftypefn {Built-in Function} {@var{val} =} pathsep ()\n\ 721 @deftypefn {Built-in Function} {@var{val} =} pathsep ()\n\
721 @deftypefnx {Built-in Function} {@var{old_val} =} pathsep (@var{new_val})\n\ 722 @deftypefnx {Built-in Function} {@var{old_val} =} pathsep (@var{new_val})\n\
722 Query or set the character used to separate directories in\n\ 723 Query or set the character used to separate directories in\n\
723 a path.\n\ 724 a path.\n\
724 @seealso{filesep, dir, ls}\n\ 725 @seealso{filesep, dir, ls}\n\
725 @end deftypefn") 726 @end deftypefn")
761 return retval; 762 return retval;
762 } 763 }
763 764
764 DEFUN (confirm_recursive_rmdir, args, nargout, 765 DEFUN (confirm_recursive_rmdir, args, nargout,
765 "-*- texinfo -*-\n\ 766 "-*- texinfo -*-\n\
766 @deftypefn {Built-in Function} {@var{val} =} confirm_recursive_rmdir ()\n\ 767 @deftypefn {Built-in Function} {@var{val} =} confirm_recursive_rmdir ()\n\
767 @deftypefnx {Built-in Function} {@var{old_val} =} confirm_recursive_rmdir (@var{new_val})\n\ 768 @deftypefnx {Built-in Function} {@var{old_val} =} confirm_recursive_rmdir (@var{new_val})\n\
768 Query or set the internal variable that controls whether Octave\n\ 769 Query or set the internal variable that controls whether Octave\n\
769 will ask for confirmation before recursively removing a directory tree.\n\ 770 will ask for confirmation before recursively removing a directory tree.\n\
770 @end deftypefn") 771 @end deftypefn")
771 { 772 {