Skip to content

Auto prepend man page with personal notes in editor

Notifications You must be signed in to change notification settings

Cody-Learner/manl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 

Repository files navigation

manl

Manl combines a manpage, prepended with your personal notes in a CLI or GUI editor.
Makes it convenient to create/edit and save new/edited notes while reviewing manpages.
Automatically seperates notes from manpage and saves notes to ~/.manl/<manpage name>.

Copy/paste in an editor, information from manpages, add content, save to your notes.
File name and path are preset by manl, just save your changes.
Next time you use manl , your notes will be printed above the manpage.

Operations:
-h --help = help page
-Sn = Search for <manpage> numbers
-St = Search manpages for <term> "man -k <term>"

Usage:
manl [operation] -or- manl <number manpage>
Examples:
manl signal -or- manl 7 signal
manl -Sn signal

Screenshot manl: https://cody-learner.github.io/find.html

UPDATE For July 20, 2024
Added to manl:
Dependencies list.
Script exits with message upon 'EDITOR' variable not being setup.
Creates $HOME/.manl directory if not present.

UPDATE For July 13, 2024
Brought up to date of currently used script.

UPDATE For Feb 25 and 26, 2024
Man pages added an empty line at beginning, breaking the 'del' variable.
Revised code to detect first non empty line.
Removed function wrapping entire script that was attempting to background it in the shell.
Added some troubleshooting information code.
Revised printed to shell message for clarity.
Added the "-i" edit in place option to sed resulting in code reducion.
Added comment related to shell check.
Combined two awk commands into one used in the "del" variable assignment.

About

Auto prepend man page with personal notes in editor

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages