Linux/UNIX
man
page integrations
man
page parsing is used extensively throughout Murex.
From providing default autocompletions through to quick access of those
manuals via the [f1]
preview pane.
This document describes the various different integrations around
those man
pages.
Please note that this is only supported on Linux, macOS, BSD and other UNIX-like platforms. Windows and Plan 9 do not currently support these specific integrations.
Autocomplete, sometimes referred to as “tab-completion”, are command
and parameter suggestions offered when you press [tab]
.
A lot of commands will have a bespoke autocomplete config defined
for them. However writing autocomplete rules for every command out there
would be hugely time consuming and impractical. Thus Murex can
automatically generate autocompletions based on the contents of
a commands man
page.
If you want to quickly read a man
page without
disrupting your flow in the command line, then you can press
[f1]
to preview it.
This preview will allow you to keep typing out your command line
while also presenting the man
page in an easy to read
layout.
When you type a command in, you will see a brief description of what
that command is, in your hint text.
That command will generally be pulled from its accompanying
man
page.
event
): Event driven programming for shell
scriptsmurex-docs
): Displays the man pages for Murex
builtinsautocomplete
): Set definitions for tab-completion in
the command lineonPreview
: Full
screen previews for files and command documentationmake
:
make
integrationsman
page integrationsdirenv
Integrations: Directory specific environmental variablesyarn
Integrations: Working with yarn
and
package.json
This document was generated from gen/integrations/man_doc.yaml.
This site's content is rebuilt automatically from murex's source code after each merge to the master
branch. Downloadable murex binaries are also built with the website.
Last built on Wed Jan 15 23:07:50 UTC 2025 against commit b4c4296b4c429617fd41527ea0efef33c52c15ef2b64972.
Current version is 6.4.2063 (develop) which has been verified against tests cases.