STDM (search the damn manual)

Linux man page search engine written in c++

Quick Start

STDM is a command line tool to search linux manual pages offline on the system and provides you with relevent information you need. It provides search results by providing excerpt from the manual instead of scrolling through the whole manual for relevent piece of information from the manual it provides you in a nice table format what you need increasing productivity and speed.

Display Options

-f display the full manual with example manual if available -s search the manual page with the functionality -e give the example manual if available -l the number of lines of excerpt to display from the manual (default: 5) -L provide an appropriate launcher (default: fzf) -S search the manual by providing a search term should be used with option ‘-s’ (default: None)

Examples

search the manual name on the basis of functionality and read about it’s functionality from the manual

stdm -s symlink

select the manual you want to search from the menu.

select the excerpt you want to read from the manual about the functionality.

search the manual you know for specific things

stdm -S animate -s lolcat

increase the size of the excerpt.

stdm -l 10 -S animate -s lolcat

use other launchers.

stdm -l 10 -L "dmenu -i -l 20 -p 'search'" -S link -s cp

display the menu with dmenu launcher.

Installation

Arch Linux

The package is available in the aur and in neon-os (arch distro) repo

paru -S stdm-git

add the following lines in the pacman.conf.

[neon-os-core-repo]
SigLevel = Required DatabaseOptional
Server = https://gitlab.com/neon-os/$repo/-/raw/main/$arch

Important: add the key server, recieve the keys and sign the keys locally.

grep -qxF "keyserver.ubuntu.com:80" /etc/pacman.d/gnupg/gpg.conf || echo "keyserver hkp://keyserver.ubuntu.com:80" | sudo tee -a /etc/pacman.d/gnupg/gpg.conf
grep -qxF "keyserver.ubuntu.com:443" /etc/pacman.d/gnupg/gpg.conf || echo "keyserver hkps://keyserver.ubuntu.com:443" | sudo tee -a /etc/pacman.d/gnupg/gpg.conf
sudo pacman-key --recv-key 51F9A14D1DEE561A
sudo pacman-key --lsign-key 51F9A14D1DEE561A

before installing stdm from pacman. make sure you have tabulate c++ module dependency installed through the aur.

paru -S tabulate

Sync the repository before installing it and also during the sync process it will complain about missing Keys. It is normal and accept the prompt to import it and you are good to go :).

sudo pacman -Syyu

then install it using pacman

sudo pacman -S stdm-git

Other Distros

currently the package is not available on other linux distros. But with contribution and support it can be made available on other distros as well.

Contributing

Contributions are welcome. It does not matter who you are you can still contribute to the project in your way :).

Not a developer but still want to contribute

Here is video by Mr. Nick on how to contribute and credit to him as well

Developer

If you are developer, have a look at the CONTRIBUTING.org document for more information.

License

The project is available under the GPLv3 license.

neon-mmd/stdm