https://github.com/woodruffw/eman
Utilities for embedded manpages.
https://github.com/woodruffw/eman
Last synced: 7 months ago
JSON representation
Utilities for embedded manpages.
- Host: GitHub
- URL: https://github.com/woodruffw/eman
- Owner: woodruffw
- License: mit
- Created: 2018-11-01T01:51:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-01T01:51:39.000Z (almost 7 years ago)
- Last Synced: 2025-03-10T19:06:06.660Z (7 months ago)
- Language: Shell
- Size: 1.95 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
eman
====
Utilities for embedded manpages.
## Why?
I've never liked the fact that programs and their manpages used separate files — it adds an
additional file to worry about when installing software, and another thing to edit when bumping
a program's version.
So, I wrote some scripts for embedding manpages in custom ELF sections, plus extracting
those sections for viewing in `man`. It might also work with non-ELF binaries, although I haven't
tried those.
## Usage
You shouldn't use this, it's just an experiment. But, if you'd like to play with it:
```bash
# embed a manpage into a binary.
# compression is ignored; any and all contents are inserted into the .manpage section.
$ eman-embed /bin/bash /usr/share/man/man1/bash.1.gz ~/mybash
# view the .manpage section
$ eman ~/mybash
# gracefully fall back to normal `man`
$ eman bash
# section numbers also work
$ eman 2 read
```