There are a number of executables installed with Portmod, however for
the most part you only need to use the
portmod executable, combined
with the prefix name you created using the
portmod init subcommand,
which will be represented here by
Mods can be installed by passing the relevant atoms as command line
arguments to the merge command. E.g.:
portmod <prefix> merge omwllf
You can search for mods using the
search subcommand. By default, it
searches the name only but will also search the description if you
-d option. E.g.:
portmod <prefix> search --description foo
Specific versions of mods can be installed by including the version
portmod <prefix> merge abandoned-flat-2.0
Specified mods will be automatically be downloaded, configured and installed.
--depclean flag will remove the specified mods and all
mods that depend on, or are dependencies of, the specified mods.
--unmerge flag will remove the specified mods, ignoring
You can view useful information about your current setup using
portmod <prefix> info.
Changes to package repositories can be fetched using the
portmod sync command.
You can update all installed mods (including dependencies and dependency
changes) using the command
portmod <prefix> merge --update --deep @world (or
portmod <prefix> merge -uD @world)
After updates, you should clean unneeded dependencies using
portmod <prefix> merge --depclean (without any arguments). This can
also be done during updates using the
however you should carefully examine the transaction list to make sure
that it isn’t removing anything you wanted to keep.
Downloaded source files are stored in
portmod <prefix> info). Additionally, portmod will
also detect files found in
~/Downloads, as well as the path stored
DOWNLOADS environment variable, if present. These files will
be moved into
$CACHE_DIR/downloads during installation.
Note that due to technical limitations of the
download files cannot include spaces, and in the case of manual
downloads these will usually be replaced by underscores in the file
expected by portmod. To handle this, portmod will detect and rename such
files containing spaces to include only underscores, there is no need to
rename them manually.