docs/reference/commands/index.btft

[table class="topnav"]
[tr]
[td class="logotab"]mp[e]
[td][see name="index"]index[e][e]
[td][see name="guide/index"]guide[e][e]
[td][see name="reference/index"]reference[e][e]
[e]
[e]
 
[h1]commands[e]
 
one page per mp <command>, each rendered from the same source both here and as a man page (see [see name="reference/testing"]testing[e]'s sibling doc, [code]mk/dm.sh[e], for how). [see name="guide/using-mp"]guide/using-mp[e] is the narrative command tour if you just want to see them strung together into real workflows; these pages are the precise, one-command-at-a-time reference.
 
every command accepts, in any order alongside its own arguments: [code]--force[e], [code]--no-deps[e], [code]--unmask[e], [code]--config=<file>[e], and (where it makes sense) [code]--sysroot=<name>[e]. those are documented once, in [see name="reference/config"]reference/config[e] and [see name="reference/mp-conf-example"]mp.conf.example[e], not repeated on every page below.
 
[h2]finding and inspecting[e]
 
[see name="reference/commands/search"]search[e] - substring match over every port's cat/name
 
[see name="reference/commands/list"]list[e] - every port in every configured repo, or --installed for the live db
 
[see name="reference/commands/info"]info[e] - one port's full metadata, effective deps/USE, and install status
 
[see name="reference/commands/files"]files[e] - every file an installed package's manifest claims
 
[see name="reference/commands/owns"]owns[e] - which package (if any) claims a given path, walking symlinks
 
[see name="reference/commands/why"]why[e] - what installed package (if any) depends on a given one
 
[see name="reference/commands/tree"]tree[e] - a package's own dependency tree, as declared
 
[see name="reference/commands/revdep"]revdep[e] - who actually links against a package's shared libs
 
[see name="reference/commands/slots"]slots[e] - every slot a pkg_name resolves to, and which one auto-picks
 
[see name="reference/commands/providers"]providers[e] - every port declaring a given %tag, ranked by pkg_pref
 
[see name="reference/commands/version"]version[e] - mp's own version, what mpx was built with, the command list
 
[h2]installing and removing[e]
 
[see name="reference/commands/install"]install[e] - resolve and install one or more packages
 
[see name="reference/commands/reinstall"]reinstall[e] - rebuild an already-declared package (--inplace supported)
 
[see name="reference/commands/remove"]remove[e] - remove one or more installed packages
 
[see name="reference/commands/update"]update[e] - sync, then rebuild a set in dependency order (--resume supported)
 
[see name="reference/commands/prune"]prune[e] - remove anything installed as a dependency nothing needs anymore
 
[see name="reference/commands/dryrun"]dryrun[e] - resolve a request without installing anything
 
[see name="reference/commands/fetch"]fetch[e] - pre-warm a port's fetch cache without building it
 
[see name="reference/commands/clean"]clean[e] - clear a stuck or stray stage directory
 
[see name="reference/commands/manifest_clean"]manifest_clean[e] - delete every file a package's manifest lists, without a full remove
 
[h2]persistent per-package state[e]
 
[see name="reference/commands/hold"]hold[e] / [see name="reference/commands/unhold"]unhold[e] - block install/remove/reinstall/update
 
[see name="reference/commands/mask"]mask[e] / [see name="reference/commands/unmask"]unmask[e] - hide from auto-pick, block explicit install
 
[see name="reference/commands/use"]use[e] - list or toggle a port's USE flags
 
[see name="reference/commands/conflicts"]conflicts[e] - list or toggle a port's declared conflicts
 
[h2]repos, sets, sysroots, and integrity[e]
 
[see name="reference/commands/sync"]sync[e] - pull every configured repo, nothing else
 
[see name="reference/commands/export"]export[e] - snapshot requested packages into a reusable set file
 
[see name="reference/commands/sysroot"]sysroot[e] - fold a sysroot's installed packages onto the live root
 
[see name="reference/commands/verify"]verify[e] - every port in the tree parses and has no dependency cycle
 
[see name="reference/commands/hook"]hook[e] - fire a custom hook event from inside a phase script
 
[see name="reference/commands/rescue"]rescue[e] - emergency rebuild+reinstall of mp itself, no USE-flag gating
 
[quote class="note"]
note: [code]mp help[e] just prints the usage summary above (the discovered command/plugin list, package-set/%tag/world/all syntax, and a pointer to [see name="reference/mp-conf-example"]mp.conf.example[e]) -- it isn't its own reference page, since there's nothing to it beyond that listing.
[e]