Mercurial > hg > octave-nkf

diff doc/interpreter/system.txi @ 12211:11faa69c4eaa

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add S_ISBLK and family of functions to documentation. Improve docstrings for functions in System Utilities::File Utilities.
author Rik <octave@nomad.inbox5.com>
date Sat, 29 Jan 2011 21:28:38 -0800
parents 9611014e7cf1
children f1ab2a12b4f4
line wrap: on
line diff
--- a/doc/interpreter/system.txi
+++ b/doc/interpreter/system.txi
@@ -149,22 +149,23 @@
 @node Filesystem Utilities
 @section Filesystem Utilities
 
-Octave includes the following functions for renaming and deleting files,
-creating, deleting, and reading directories, and for getting information
-about the status of files.
+Octave includes many utility functions for copying, moving, renaming, and deleting files; for creating, reading, and deleting directories; for retrieving
+status information on files; and for manipulating file and path names.
+
+@DOCSTRING(movefile)
 
 @DOCSTRING(rename)
 
+@DOCSTRING(copyfile)
+
+@DOCSTRING(unlink)
+
 @DOCSTRING(link)
 
 @DOCSTRING(symlink)
 
 @DOCSTRING(readlink)
 
-@DOCSTRING(unlink)
-
-@DOCSTRING(readdir)
-
 @DOCSTRING(mkdir)
 
 @DOCSTRING(rmdir)
@@ -178,43 +179,53 @@
 @anchor{doc-lstat}
 @DOCSTRING(stat)
 
+@DOCSTRING(S_ISBLK)
+
+@DOCSTRING(S_ISCHR)
+
+@DOCSTRING(S_ISDIR)
+
+@DOCSTRING(S_ISFIFO)
+
+@DOCSTRING(S_ISLNK)
+
+@DOCSTRING(S_ISREG)
+
 @DOCSTRING(fileattrib)
 
 @DOCSTRING(isdir)
 
+@DOCSTRING(readdir)
+
 @DOCSTRING(glob)
 
 @DOCSTRING(fnmatch)
 
 @DOCSTRING(file_in_path)
 
+@DOCSTRING(filesep)
+
+@DOCSTRING(filemarker)
+
+@DOCSTRING(fileparts)
+
+@DOCSTRING(fullfile)
+
 @DOCSTRING(tilde_expand)
 
 @DOCSTRING(canonicalize_file_name)
 
-@DOCSTRING(movefile)
-
-@DOCSTRING(copyfile)
-
-@DOCSTRING(fileparts)
-
-@DOCSTRING(filesep)
-
-@DOCSTRING(filemarker)
-
-@DOCSTRING(fullfile)
-
-@DOCSTRING(tempdir)
-
-@DOCSTRING(tempname)
-
-@DOCSTRING(P_tmpdir)
+@DOCSTRING(make_absolute_filename)
 
 @DOCSTRING(is_absolute_filename)
 
 @DOCSTRING(is_rooted_relative_filename)
 
-@DOCSTRING(make_absolute_filename)
+@DOCSTRING(P_tmpdir)
+
+@DOCSTRING(tempdir)
+
+@DOCSTRING(tempname)
 
 @node File Archiving Utilities
 @section File Archiving Utilities