luarocks

• Index

Contents

• Functions

Modules

• luarocks.add
• luarocks.build
• luarocks.build.builtin
• luarocks.build.cmake
• luarocks.build.command
• luarocks.build.lake
• luarocks.build.make
• luarocks.cache
• luarocks.cfg
• luarocks.command_line
• luarocks.config
• luarocks.deps
• luarocks.dir
• luarocks.download
• luarocks.fetch
• luarocks.fetch.cvs
• luarocks.fetch.git
• luarocks.fetch.sscm
• luarocks.fetch.svn
• luarocks.fs
• luarocks.fs.lua
• luarocks.fs.unix
• luarocks.fs.unix.tools
• luarocks.fs.win32
• luarocks.fs.win32.tools
• luarocks.help
• luarocks.index
• luarocks.install
• luarocks.list
• luarocks.loader
• luarocks.make
• luarocks.make_manifest
• luarocks.manif
• luarocks.manif_core
• luarocks.pack
• luarocks.path
• luarocks.persist
• luarocks.refresh_cache
• luarocks.remove
• luarocks.rep
• luarocks.require
• luarocks.search
• luarocks.show
• luarocks.tools.tar
• luarocks.tools.zip
• luarocks.type_check
• luarocks.unpack
• luarocks.util
• luarocks.validate

Module luarocks.fs.unix.tools

fs operations implemented with third-party tools for Unix platform abstractions.

Functions

execute_string (cmd)	Run the given command.
current_dir ()	Obtain current directory.
change_dir (d)	Change the current directory.
change_dir_to_root ()	Change directory to root.
pop_dir ()	Change working directory to the previous in the dir stack.
make_dir (d)	Create a directory if it does not already exist.
remove_dir_if_empty (dir, d)	Remove a directory if it is empty.
remove_dir_tree_if_empty (dir, d)	Remove a directory if it is empty.
copy (src, dest)	Copy a file.
copy_contents (src, dest)	Recursively copy the contents of a directory.
delete (arg)	Delete a file or a directory and all its contents.
list_dir (at)	List the contents of a directory.
find (at)	Recursively scan the contents of a directory.
zip (zipfile, ...)	Compress files in a .zip archive.
unzip (zipfile)	Uncompress files from a .zip archive.
exists (file)	Test for existance of a file.
is_writable (file)	Test is file/dir is writable.
is_dir (file)	Test is pathname is a directory.
is_file (file)	Test is pathname is a regular file.
download (url, filename)	Download a remote file.
apply_patch (patchname)	Apply a patch.
unpack_archive (archive)	Unpack an archive.
get_md5 (file, md5sum)	Get the MD5 checksum for a file.
unpack_archive (archive)	Unpack an archive.

Functions

execute_string (cmd)

Run the given command. The command is executed in the current directory in the dir stack.

Parameters:

• cmd: string: No quoting/escaping is applied to the command.

Returns:

boolean: true if command succeeds (status code 0), false otherwise.

current_dir ()

Obtain current directory. Uses the module's internal dir stack.

Returns:

string: the absolute pathname of the current directory.

change_dir (d)

Change the current directory. Uses the module's internal dir stack. This does not have exact semantics of chdir, as it does not handle errors the same way, but works well for our purposes for now.

Parameters:

• d: string: The directory to switch to.

change_dir_to_root ()

Change directory to root. Allows leaving a directory (e.g. for deleting it) in a crossplatform way.

pop_dir ()

Change working directory to the previous in the dir stack.

make_dir (d)

Create a directory if it does not already exist. If any of the higher levels in the path name does not exist too, they are created as well.

Parameters:

• d: string: pathname of directory to create.

Returns:

boolean: true on success, false on failure.

remove_dir_if_empty (dir, d)

Remove a directory if it is empty. Does not return errors (for example, if directory is not empty or if already does not exist)

Parameters:

• dir: string: pathname of directory to remove.
• d:

remove_dir_tree_if_empty (dir, d)

Remove a directory if it is empty. Does not return errors (for example, if directory is not empty or if already does not exist)

Parameters:

• dir: string: pathname of directory to remove.
• d:

copy (src, dest)

Copy a file.

Parameters:

• src: string: Pathname of source
• dest: string: Pathname of destination

Returns:

boolean or (boolean, string): true on success, false on failure, plus an error message.

copy_contents (src, dest)

Recursively copy the contents of a directory.

Parameters:

• src: string: Pathname of source
• dest: string: Pathname of destination

Returns:

boolean or (boolean, string): true on success, false on failure, plus an error message.

delete (arg)

Delete a file or a directory and all its contents. For safety, this only accepts absolute paths.

Parameters:

• arg: string: Pathname of source

Returns:

boolean: true on success, false on failure.

list_dir (at)

List the contents of a directory.

Parameters:

• at: string or nil: directory to list (will be the current directory if none is given).

Returns:

table: an array of strings with the filenames representing the contents of a directory.

find (at)

Recursively scan the contents of a directory.

Parameters:

• at: string or nil: directory to scan (will be the current directory if none is given).

Returns:

table: an array of strings with the filenames representing the contents of a directory.

zip (zipfile, ...)

Compress files in a .zip archive.

Parameters:

• zipfile: string: pathname of .zip archive to be created.
• ...: Filenames to be stored in the archive are given as additional arguments.

Returns:

boolean: true on success, false on failure.

unzip (zipfile)

Uncompress files from a .zip archive.

Parameters:

• zipfile: string: pathname of .zip archive to be extracted.

Returns:

boolean: true on success, false on failure.

exists (file)

Test for existance of a file.

Parameters:

• file: string: filename to test

Returns:

boolean: true if file exists, false otherwise.

is_writable (file)

Test is file/dir is writable.

Parameters:

• file: string: filename to test

Returns:

boolean: true if file exists, false otherwise.

is_dir (file)

Test is pathname is a directory.

Parameters:

• file: string: pathname to test

Returns:

boolean: true if it is a directory, false otherwise.

is_file (file)

Test is pathname is a regular file.

Parameters:

• file: string: pathname to test

Returns:

boolean: true if it is a regular file, false otherwise.

download (url, filename)

Download a remote file.

Parameters:

• url: string: URL to be fetched.
• filename: string or nil: this function attempts to detect the resulting local filename of the remote file as the basename of the URL; if that is not correct (due to a redirection, for example), the local filename can be given explicitly as this second argument.

Returns:

boolean: true on success, false on failure.

apply_patch (patchname)

Apply a patch.

Parameters:

• patchname: string: The filename of the patch.

unpack_archive (archive)

Unpack an archive. Extract the contents of an archive, detecting its format by filename extension.

Parameters:

• archive: string: Filename of archive.

Returns:

boolean or (boolean, string): true on success, false and an error message on failure.

get_md5 (file, md5sum)

Get the MD5 checksum for a file.

Parameters:

• file: string: The file to be computed.
• md5sum:

Returns:

string: The MD5 checksum

unpack_archive (archive)

Unpack an archive. Extract the contents of an archive, detecting its format by filename extension.

Parameters:

• archive: string: Filename of archive.

Returns:

boolean or (boolean, string): true on success, false and an error message on failure.