~theorytoe/mman

06976076cb38e487c94635f52467d7f0b7c729b9 — theorytoe 6 months ago d60d26a
add: README & Makefile
2 files changed, 49 insertions(+), 0 deletions(-)

A Makefile
A README.md
A Makefile => Makefile +15 -0
@@ 0,0 1,15 @@
PREFIX=/usr/local

.PHONY=all install uninstall

all: install

install:
	install -Dm 755 mman $(PREFIX)/bin/mman
	gzip -k mman.1
	install -Dm 644 mman.1.gz $(PREFIX)/share/man/man1/mman.1.gz 
	rm -f mman.1.gz

uninstall:
	rm -df $(PREFIX)/bin/mman
	rm -df $(PREFIX)/share/man/man1/mman.1.gz

A README.md => README.md +34 -0
@@ 0,0 1,34 @@
# mman (my man)

mman is a tool for organizing & editing personal manpages.
It allows for a variety of formats for authoring:

- plaintext
- (n,g)roff
- mandoc
- scdoc

## installation

```
sudo make install
```
There are also a couple of patches:

- `./no-scdoc.patch` -- remove scdoc support
- `./no-troff.patch` -- remove troff "support"
- `./no-txt.patch`   -- remove plaintext "support"

patches can be applied/removed withe the following commands

```bash
patch < [patch-name].patch    # apply patch
patch -R < [patch-name].patch # restore patch
```

## contributing

Send patches to <~theorytoe/public-inbox@lists.sr.ht>.
Please modify the [PATCH] subject line to [PATCH mman].

<!-- vim set cc=80 tw=80 : -->