Additional operating system utilities

Usage:warn_on_nosuccess(G)

Call G (cutting solutions, i.e., as once/1) and show warning messages if something went wrong (failure and exceptions).

Usage:ignore_nosuccess(G)

Call G and ignore if something went wrong (failure and exceptions).

Usage:del_dir_if_empty(D)

Delete D if it is an empty directory.

• The following properties should hold at call time:
  (basic_props:atm/1)D is an atom.

Usage:empty_dir(D)

D is an empty directory

• The following properties should hold at call time:
  (basic_props:atm/1)D is an atom.

Usage:move_files(Files,Dir)

Move Files to directory Dir (note that to move only one file to a directory, rename_file/2 can be used).

• The following properties should hold at call time:
  (basic_props:list/2)Files is a list of atms.
  (basic_props:atm/1)Dir is an atom.

Usage:move_file(File,Dir)

Move File to directory Dir

• The following properties should hold at call time:
  (basic_props:atm/1)File is an atom.
  (basic_props:atm/1)Dir is an atom.

Usage:copy_files(Files,Dir)

Like copy_files/3, with empty options list.

• The following properties should hold at call time:
  (basic_props:list/2)Files is a list of atms.
  (basic_props:atm/1)Dir is an atom.

Usage:copy_files(Files,Dir,Opts)

Copy Files to directory Dir, using Opts as the option list for copy. See copy_file/3 for the list of options. Note that to move only one file to a directory, rename_file/2 can be used.

• The following properties should hold at call time:
  (basic_props:list/2)Files is a list of atms.
  (basic_props:atm/1)Dir is an atom.
  (system:copy_options/1)Opts is a list of file copy options.

Usage:copy_files_nofail(Files,Dir,Opts)

Like copy_files/3, but do not fail in case of errors.

• The following properties should hold at call time:
  (basic_props:list/2)Files is a list of atms.
  (basic_props:atm/1)Dir is an atom.
  (system:copy_options/1)Opts is a list of file copy options.

Usage:del_file_nofail(File)

Like delete_file/1, but do not fail in case of errors.

• The following properties should hold at call time:
  (basic_props:atm/1)File is an atom.

Usage:del_files_nofail(Files)

Like del_file_nofail/1, but takes list of files in Files.

• The following properties should hold at call time:
  (basic_props:list/2)Files is a list of atms.

Usage:file_to_line(File,Str)

• The following properties should hold at call time:
  (basic_props:list/2)File is a list of atms.
  (basic_props:string/1)Str is a string (a list of character codes).

Usage:replace_strings_in_file(Ss,F1,F2)

Like replace_strings/3 but from file F1 to file F2.

• The following properties should hold at call time:
  (basic_props:list/2)Ss is a list of strings.
  (basic_props:atm/1)F1 is an atom.
  (basic_props:atm/1)F2 is an atom.

Usage:backup_file(FileName)

Save a backup copy of file FileName

• The following properties should hold at call time:
  (basic_props:atm/1)FileName is an atom.

Usage:move_if_diff(From,To,NewOrOld)

If To does not exist, or its contents are different from From, delete To and rename From to To. NewOrOld is unified with new or old depending on whether the new or the old file is preserved.

• The following properties should hold at call time:
  (basic_props:atm/1)From is an atom.
  (basic_props:atm/1)To is an atom.
• The following properties should hold upon exit:
  (basic_props:atm/1)NewOrOld is an atom.

Usage:set_file_owner(File,Owner)

Set user/group of a file.

• The following properties should hold at call time:
  (term_typing:nonvar/1)File is currently a term which is not a free variable.
  (term_typing:nonvar/1)Owner is currently a term which is not a free variable.

Usage:set_file_perms(File,Perms)

Set permissions of File to Perms.

• The following properties should hold at call time:
  (system_extra:perms_term/1)Perms is a term providing modes for User, Group, and Others.
  (basic_props:atm/1)File is an atom.

Perms is a term providing valid permissions (``modes'') for User, Group, and Others. These are all valid_mode/1s. Defined as follows:

perms_term(perms(U,G,O)) :-
    valid_mode(U),
    valid_mode(G),
    valid_mode(O).

Usage:perms_term(Perms)

Perms is a term providing modes for User, Group, and Others.

Mode is an atom that provides a valid set of file permissions (a valid ``mode''). Defined as follows:

valid_mode('').
valid_mode('X').
valid_mode(x).
valid_mode(w).
valid_mode(wX).
valid_mode(wx).
valid_mode(r).
valid_mode(rX).
valid_mode(rx).
valid_mode(rw).
valid_mode(rwX).
valid_mode(rwx).

Usage:valid_mode(Mode)

Mode is a file permissions mode.

Usage:set_exec_perms(File,Perms)

Set file permissions, but treat regular files as directories w.r.t. 'X' flag

Usage:mkpath(Path)

Creates the directories necessary to access the given Path (which can be absolute or relative).

• The following properties should hold at call time:
  (stream_basic:sourcename/1)Path is a source name.

Usage:mkpath(Path,Perms)

Like mkpath, but sets permissions of new directories as Perms.

• The following properties should hold at call time:
  (stream_basic:sourcename/1)Path is a source name.
  (basic_props:term/1)Perms is any term.

Usage:mkpath(Path,Perms,Owner)

Like mkpath, but sets permissions and owner of new directories to Perms and Owner.

• The following properties should hold at call time:
  (stream_basic:sourcename/1)Path is a source name.
  (basic_props:term/1)Perms is any term.
  (basic_props:term/1)Owner is any term.

Usage:

Equivalent to mkpath_mode(Path,Mode,_).

• The following properties should hold at call time:
  (stream_basic:sourcename/1)Arg1 is a source name.
  (basic_props:int/1)Arg2 is an integer.

Usage:

Equivalent to mkpath_mode(Path,0o777,_).

• The following properties should hold at call time:
  (stream_basic:sourcename/1)Arg1 is a source name.

Usage:mktempdir_in_tmp(Template,Path)

Create a directory in the temporary directory using Template (see mktemp_in_tmp/2). An empty file CREATED_WITH_MKTEMPDIR is created inside Path as a safety check for rmtempdir/1.

Usage:rmtempdir(Path)

Remove the temporary directory Path (recursively) created with mktempdir_in_tmp/2. As a safety check, this predicate throws an exception if the CREATED_WITH_MKTEMPDIR file is not in Path.

Usage:create_rel_link(From,To)

Create a relocatable symlink (computing relative paths) (e.g., /a/b/c (symlink) -> /a/d/e becomes /a/b/c (symlink) -> ../d/e

Usage:create_link(From,To)

Create a symlink from From to To. On platforms where symlinks are not supported (Windows) the file is copied instead. The file To is removed if it existed before.

Usage:relpath(A,B,C)

C is a path to B relative to A (using .. if needed) (e.g., /a/b/c -> /a/d/e becomes /a/b/c -> ../../d/e. Assume both are absolute, otherwise just return B.

Usage:istty(FD)

Check if the file descriptor is associated with a terminal.