add makefile and manpage

This commit is contained in:
Ben Harris 2018-09-05 21:20:02 -04:00
parent cdef21ce0d
commit 4c3fe64acd
2 changed files with 55 additions and 0 deletions

22
Makefile Normal file
View File

@ -0,0 +1,22 @@
PREFIX ?= /usr/local
BINDIR ?= $(PREFIX)/bin
MANDIR ?= $(PREFIX)/share/man
install:
@echo Installing the executable to $(BINDIR)
@mkdir -p $(BINDIR)
@cp -f tilde $(BINDIR)/tilde
@chmod 755 $(BINDIR)/tilde
@echo Installing the manual page to $(MANDIR)/man1
@mkdir -p $(MANDIR)/man1
@cp -f tilde.1 $(MANDIR)/man1/tilde.1
@chmod 644 $(MANDIR)/man1/tilde.1
uninstall:
@echo Removing the executable from $(BINDIR)
@rm -f $(BINDIR)/tilde
@echo Removing the manual page from $(MANDIR)/man1
@rm -f $(BINDIR)/man1/tilde.1
.PHONY: install uninstall

33
tilde.1 Normal file
View File

@ -0,0 +1,33 @@
.TH tilde 1 "5 September 2018" "v0.0.2"
.SH NAME
tilde \- user script wrapper and submission tool
.SH SYNOPSIS
.B tilde [options] (scriptname)
.P
.SH DESRIPTION
.B tilde
is a wrapper around user-submitted scripts.
any accepted script in /tilde/bin can be run with
the wrapper feature.
users can submit any script in their ~/bin directory
which will be mailed to admins for review.
.SH USAGE
.TP
.B tilde list
List all available scripts in /tilde/bin
.TP
.B tilde [scriptname]
Run scriptname.
.TP
.B tilde submit
Submit a script from your ~/bin directory
.TP
.B tilde about [scriptname]
Get the submitter's description for a script.
.SH DEPENDENCIES
None.
.SH BUGS
None known. Please submit to https://tildegit.org/team/tilde-launcher/issues
.SH AUTHOR
Ben Harris <ben (at) tilde (dot) team>