Navigation

Operators and Keywords

Function List:

C++ API

dirfns.cc File Reference

#include <cerrno>
#include <cstdio>
#include <cstddef>
#include <cstdlib>
#include <cstring>
#include <sstream>
#include <string>
#include "file-ops.h"
#include "file-stat.h"
#include "glob-match.h"
#include "oct-env.h"
#include "pathsearch.h"
#include "str-vec.h"
#include "Cell.h"
#include "defun.h"
#include "dir-ops.h"
#include "dirfns.h"
#include "error.h"
#include "gripes.h"
#include "input.h"
#include "load-path.h"
#include "oct-obj.h"
#include "pager.h"
#include "procstream.h"
#include "sysdep.h"
#include "toplev.h"
#include "unwind-prot.h"
#include "utils.h"
#include "variables.h"

Include dependency graph for dirfns.cc:


Functions

 DEFUN (cd, args,,"-*- texinfo -*-\n\ @deffn {Command} cd dir\n\ @deffnx {Command} chdir dir\n\ Change the current working directory to @var{dir}. If @var{dir} is\n\ omitted, the current directory is changed to the user's home\n\ directory. For example,\n\ \n\ @example\n\ cd ~/octave\n\ @end example\n\ \n\ @noindent\n\ Changes the current working directory to @file{~/octave}. If the\n\ directory does not exist, an error message is printed and the working\n\ directory is not changed.\n\ @seealso{mkdir, rmdir, dir}\n\ @end deffn")
 DEFALIAS (chdir, cd)
 DEFUN (pwd,,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} pwd ()\n\ Return the current working directory.\n\ @seealso{dir, ls}\n\ @end deftypefn")
 DEFUN (readdir, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{files}, @var{err}, @var{msg}] =} readdir (@var{dir})\n\ Return names of the files in the directory @var{dir} as a cell array of\n\ strings. If an error occurs, return an empty cell array in @var{files}.\n\ \n\ If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ @seealso{dir, glob}\n\ @end deftypefn")
 DEFUN (mkdir, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{dir})\n\ @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@var{parent}, @var{dir})\n\ Create a directory named @var{dir} in the directory @var{parent}.\n\ \n\ If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty\n\ character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\ system-dependent error message, and @var{msgid} contains a unique\n\ message identifier.\n\ @seealso{rmdir}\n\ @end deftypefn")
 DEFUN (rmdir, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir})\n\ @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@var{dir}, @code{\"s\"})\n\ Remove the directory named @var{dir}.\n\ \n\ If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty\n\ character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\ system-dependent error message, and @var{msgid} contains a unique\n\ message identifier.\n\ \n\ If the optional second parameter is supplied with value @code{\"s\"},\n\ recursively remove all subdirectories as well.\n\ @seealso{mkdir, confirm_recursive_rmdir}\n\ @end deftypefn")
 DEFUN (link, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} link (@var{old}, @var{new})\n\ Create a new link (also known as a hard link) to an existing file.\n\ \n\ If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ @seealso{symlink}\n\ @end deftypefn")
 DEFUN (symlink, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} symlink (@var{old}, @var{new})\n\ Create a symbolic link @var{new} which contains the string @var{old}.\n\ \n\ If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ @seealso{link, readlink}\n\ @end deftypefn")
 DEFUN (readlink, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{result}, @var{err}, @var{msg}] =} readlink (@var{symlink})\n\ Read the value of the symbolic link @var{symlink}.\n\ \n\ If successful, @var{result} contains the contents of the symbolic link\n\ @var{symlink}, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ @seealso{link, symlink}\n\ @end deftypefn")
 DEFUN (rename, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} rename (@var{old}, @var{new})\n\ Change the name of file @var{old} to @var{new}.\n\ \n\ If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ @seealso{ls, dir}\n\ @end deftypefn")
 DEFUN (glob, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} glob (@var{pattern})\n\ Given an array of strings (as a char array or a cell array) in\n\ @var{pattern}, return a cell array of file names that match any of\n\ them, or an empty cell array if no patterns match. Tilde expansion\n\ is performed on each of the patterns before looking for matching file\n\ names. For example,\n\ \n\ @example\n\ @group\n\ glob (\"/vm*\")\n\ @result{} \"/vmlinuz\"\n\ @end group\n\ @end example\n\ @seealso{dir, ls, stat, readdir}\n\ @end deftypefn")
 DEFUN (fnmatch, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} fnmatch (@var{pattern}, @var{string})\n\ Return 1 or zero for each element of @var{string} that matches any of\n\ the elements of the string array @var{pattern}, using the rules of\n\ filename pattern matching. For example,\n\ \n\ @example\n\ @group\n\ fnmatch (\"a*b\", @{\"ab\"; \"axyzb\"; \"xyzab\"@})\n\ @result{} [ 1; 1; 0 ]\n\ @end group\n\ @end example\n\ @end deftypefn")
 DEFUN (filesep, args,,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} filesep ()\n\ @deftypefnx {Built-in Function} {} filesep ('all')\n\ Return the system-dependent character used to separate directory names.\n\ \n\ If 'all' is given, the function return all valid file separators in\n\ the form of a string. The list of file separators is system-dependent.\n\ It is / (forward slash) under UNIX or Mac OS X, / and \\ (forward and\n\ backward slashes) under Windows.\n\ @seealso{pathsep, dir, ls}\n\ @end deftypefn")
 DEFUN (pathsep, args, nargout,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{val} =} pathsep ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} pathsep (@var{new_val})\n\ Query or set the character used to separate directories in\n\ a path.\n\ @seealso{filesep, dir, ls}\n\ @end deftypefn")
 DEFUN (confirm_recursive_rmdir, args, nargout,"-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{val} =} confirm_recursive_rmdir ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} confirm_recursive_rmdir (@var{new_val})\n\ Query or set the internal variable that controls whether Octave\n\ will ask for confirmation before recursively removing a directory tree.\n\ @end deftypefn")

Variables

octave_time Vlast_chdir_time = 0.0

Function Documentation

DEFALIAS ( chdir  ,
cd   
)

DEFUN ( confirm_recursive_rmdir  ,
args  ,
nargout   
)

DEFUN ( pathsep  ,
args  ,
nargout   
)

DEFUN ( filesep  ,
args   
)

DEFUN ( fnmatch  ,
args   
)

DEFUN ( glob  ,
args   
)

DEFUN ( rename  ,
args   
)

DEFUN ( readlink  ,
args   
)

DEFUN ( symlink  ,
args   
)

DEFUN ( link  ,
args   
)

DEFUN ( rmdir  ,
args   
)

DEFUN ( mkdir  ,
args   
)

DEFUN ( readdir  ,
args   
)

DEFUN ( pwd   ) 

DEFUN ( cd  ,
args   
)


Variable Documentation