commit f5f2ddb9fd5f8d8c93805614d9b56f0eddf04457
parent b28d45766b30ce194cc918d1d5b8994f039de1bb
Author: Pollux <pollux@pollux.codes>
Date: Tue, 11 Feb 2025 22:54:04 -0600
docs: Add man page
Signed-off-by: Pollux <pollux@pollux.codes>
Diffstat:
2 files changed, 16 insertions(+), 1 deletion(-)
diff --git a/Makefile b/Makefile
@@ -2,6 +2,7 @@
PREFIX ?= /usr/local
BINDIR ?= $(PREFIX)/bin
+MANDIR ?= $(PREFIX)/share/man
BINSUFFIX ?=
PROGNAME = sopen
@@ -32,6 +33,8 @@ clean:
rm "$(PROGNAME)$(BINSUFFIX)"
install:
- install -d $(DESTDIR)$(BINDIR)/
+ install -d $(DESTDIR)$(BINDIR)/ $(DESTDIR)$(MANDIR)/man1/
install -s -m 755 "$(PROGNAME)$(BINSUFFIX)" \
$(DESTDIR)$(BINDIR)/$(PROGNAME)$(BINSUFFIX)
+ install -m 644 -D "$(PROGNAME).1" \
+ "$(DESTDIR)$(MANDIR)/man1/"
diff --git a/sopen.1 b/sopen.1
@@ -0,0 +1,12 @@
+.TH "sopen" 1
+.SH "NAME"
+sopen \- A suckless resources opener
+.SH "SYNOPSIS"
+.B sopen <url/file>
+.SH "DESCRIPTION"
+sopen is a minimal resource opener, like mime-open, that matches compile-time
+configured regular expressions against the url or file path provided and runs
+the desired program with the same url or path.
+.SH "AUTHORS"
+sopen was written by Joseph "Pollux" Hand.
+.SH "SEE ALSO"
