summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAurélien Aptel <aurelien.aptel@gmail.com>2010-09-02 02:02:56 +0200
committerAurélien Aptel <aurelien.aptel@gmail.com>2010-09-02 02:02:56 +0200
commit2080dfebeaf82c6426c9ec2708ec8d96a7af76bb (patch)
tree5cdde8b6f9b64e92bec3deb91b9294e11541ca86
parentfbc6ec3207fa1298ec8347697ddea6b3e78f13d0 (diff)
added manpage.
-rw-r--r--Makefile8
-rw-r--r--st.121
2 files changed, 28 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 920bd9a..2da8beb 100644
--- a/Makefile
+++ b/Makefile
@@ -34,7 +34,7 @@ clean:
dist: clean
@echo creating dist tarball
@mkdir -p st-${VERSION}
- @cp -R LICENSE Makefile README config.mk config.h st.info ${SRC} st-${VERSION}
+ @cp -R LICENSE Makefile README config.mk config.def.h st.info st.1 ${SRC} st-${VERSION}
@tar -cf st-${VERSION}.tar st-${VERSION}
@gzip st-${VERSION}.tar
@rm -rf st-${VERSION}
@@ -44,10 +44,16 @@ install: all
@mkdir -p ${DESTDIR}${PREFIX}/bin
@cp -f st ${DESTDIR}${PREFIX}/bin
@chmod 755 ${DESTDIR}${PREFIX}/bin/st
+ @echo installing manual page to ${DESTDIR}${MANPREFIX}/man1
+ @mkdir -p ${DESTDIR}${MANPREFIX}/man1
+ @sed "s/VERSION/${VERSION}/g" < st.1 > ${DESTDIR}${MANPREFIX}/man1/st.1
+ @chmod 644 ${DESTDIR}${MANPREFIX}/man1/st.1
@tic -s st.info
uninstall:
@echo removing executable file from ${DESTDIR}${PREFIX}/bin
@rm -f ${DESTDIR}${PREFIX}/bin/st
+ @echo removing manual page from ${DESTDIR}${MANPREFIX}/man1
+ @rm -f ${DESTDIR}${MANPREFIX}/man1/sic.1
.PHONY: all options clean dist install uninstall
diff --git a/st.1 b/st.1
new file mode 100644
index 0000000..4d00d2f
--- /dev/null
+++ b/st.1
@@ -0,0 +1,21 @@
+.TH ST 1 st-VERSION
+.SH NAME
+st \- simple terminal
+.SH SYNOPSIS
+.B st
+.RB [ \-e " <cmd>"]
+.RB [ \-t " <title>"]
+.RB [ \-v ]
+.SH DESCRIPTION
+.B st
+is a simple terminal emulator.
+.SH OPTIONS
+.TP
+.B \-e <cmd>
+Execute cmd instead of the shell
+.TP
+.B \-t <title>
+Overrides the default title (st)
+.TP
+.BI \-v
+Prints version information to standard output, then exits.