Main module of project-independent BASIS utilities. More...
#include "Cwd.pm"
#include "File/Basename.pm"
#include "File/Spec/Functions.pm"
#include "BASIS/File/Which.pm"
#include "BASIS/Sub/Exporter.pm"
Go to the source code of this file.
Functions | |
sub | execute (scalar args, scalar quiet, scalar stdout, scalar allow_fail, scalar verbose, scalar simulate, scalar prefix, hashref targets, scalar base) |
Execute command as subprocess. | |
sub | exedir (scalar name, scalar prefix, hashref targets, scalar base) |
Get directory of executable file. | |
sub | exename (scalar name, scalar prefix, hashref targets, scalar base) |
Get name of executable file. | |
sub | exepath (scalar name, scalar prefix, hashref targets, scalar base) |
Get absolute path of executable file. | |
sub | istarget (scalar target, scalar prefix, hashref targets) |
Determine whether a given target is known. | |
sub | print_contact (scalar contact) |
Print contact information. | |
sub | print_version (scalar name, scalar version, scalar project, scalar copyright, scalar license) |
Print version information including copyright and license notices. | |
sub | qsplit (scalar str) |
Split quoted string. | |
sub | targetuid (scalar target, scalar prefix, hashref targets) |
Get UID of build target. | |
sub | tostring (arrayref args) |
Convert list to double quoted string. | |
Variables | |
const | CONTACT |
Default contact to use for help output of executables. | |
const | COPYRIGHT |
Default copyright of executables. | |
const | LICENSE |
Default license of executables. |
Detailed Description
Main module of project-independent BASIS utilities.
This module defines the BASIS utility functions. It uses the BASIS::Sub::Exporter module to enable the generation of these functions customized to the request of the particular project they are used in. This is, for example, used by the BASIS::Basis module. The default utility functions defined by this module, i.e., without any customizaton are intended for use in Perl scripts that are not build as part of a particular package. In case of a BASIS package, the already customized project-specific implementations should be used instead, i.e., those defined by the BASIS::Basis module of the project.
- Note:
- This module exports also all other BASIS utility functions that are defined in other Perl modules. Therefore, only this or the BASIS::Basis module should be used.
Copyright (c) 2011, 2012 University of Pennsylvania. All rights reserved.
See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.
Contact: SBIA Group <sbia-software at uphs.upenn.edu>
Definition in file Utilities.pm.