category
packs_common
Common predicates for the packs tool objects.
static
Public predicates
setup/0
Ensures that registries and packs directory structure exists. Preserves any defined registries and installed packs.
static
setup
- one
reset/0
Resets registries and packs directory structure. Deletes any defined registries and installed packs.
static
reset
- one
verify_commands_availability/0
Verifies required shell commands availability. Fails printing an error message if a command is missing.
static
verify_commands_availability
- zero_or_one
help/0
Provides help about the main predicates.
static
help
- one
pin/1
Pins a resource (pack or registry) preventing it from being updated, uninstalled, or deleted. Fails if the resource is not found.
static
pin(Resource)
pin(+atom)
- zero_or_one
pin/0
Pins all resource (packs or registries) preventing them from being updated, uninstalled, or deleted. Note that resources added after calling this predicate will not be pinned.
static
pin
- one
unpin/1
Unpins a resource (pack or registry), allowing it to be updated, uninstalled, or deleted. Fails if the resource is not found.
static
unpin(Resource)
unpin(+atom)
- zero_or_one
unpin/0
Unpins all resources (packs or registries), allowing them to be updated, uninstalled, or deleted.
static
unpin
- one
pinned/1
True iff the resource (pack or registry) is defined or installed and if it is pinned.
static
pinned(Resource)
pinned(+atom)
- zero_or_one
directory/2
Enumerates by backtracking all packs or registries and respective installation or definition directories.
static
directory(Resource,Directory)
directory(?atom,?atom)
- zero_or_more
directory/1
Returns the directory where the registries or the packs are installed.
static
directory(Directory)
directory(?atom)
- zero_or_one
readme/2
Returns the path to the resource (pack or registry) readme file using the internal backend format. Fails if the resource is not defined or installed or if no readme file is found for it.
static
readme(Resource,ReadMeFile)
readme(+atom,-atom)
- zero_or_one
readme/1
Prints the path to the resource (pack or registry) readme file using the native operating-system format. Fails if the resource is not defined or installed or if no readme file is found for it.
static
readme(Resource)
readme(+atom)
- zero_or_one
logtalk_packs/1
Returns the directory (using the internal backend format) where the registries, packs, and archives are installed.
static
logtalk_packs(LogtalkPacks)
logtalk_packs(-atom)
- one
logtalk_packs/0
Prints the directory (using the native operating-system format) where the registries, packs, and archives are installed.
static
logtalk_packs
- one
Protected predicates
readme_file_path/2
Returns the absolute path for the given directory readme file if it exists.
static
readme_file_path(Directory,ReadMeFile)
readme_file_path(+atom,-atom)
- zero_or_one
print_readme_file_path/1
Prints the absolute path for the given directory readme file if it exists. Succeeds otherwise.
static
print_readme_file_path(Directory)
print_readme_file_path(+atom)
- one
command/2
Executes a shell command. Prints an error message and fails if the command fails.
static
command(Command,FailureMessage)
command(+atom,@nonvar)
- zero_or_one
load_registry/1
Loads all registry files from the given directory.
static
load_registry(Directory)
load_registry(+atom)
- zero_or_one
tar_command/1
Returns the name of the tar command to be used depending on the operating-system.
static
tar_command(Command)
tar_command(-atom)
- one
supported_archive/1
True iff the archive format is supported.
static
supported_archive(Extension)
supported_archive(+atom)
- zero_or_one
Private predicates
(no local declarations; see entity ancestors if any)
Operators
(none)