commit eb74dd687a2080a0b753522f1508466c323ddb75
parent e8e577feb6009fe9feceb704902976aec4b3d6e6
Author: sin <sin@2f30.org>
Date: Tue, 22 Mar 2016 13:54:04 +0000
add manpage
Diffstat:
| M | Makefile | | | 10 | +++++----- |
| A | stun.8 | | | 44 | ++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 49 insertions(+), 5 deletions(-)
diff --git a/Makefile b/Makefile
@@ -4,7 +4,7 @@ NAME = stun
VERSION = 0.1
BIN = stun
SRC = ${BIN:=.c}
-MAN1 = ${BIN:=.1}
+MAN8 = ${BIN:=.8}
HDR = arg.h
all: $(BIN)
@@ -37,15 +37,15 @@ install: all
cp -f ${BIN} ${DESTDIR}${PREFIX}/bin
for f in $(BIN); do chmod 755 ${DESTDIR}${PREFIX}/bin/$$f; done
# installing manual pages for tools.
- mkdir -p ${DESTDIR}${MANPREFIX}/man1
- cp -f ${MAN1} ${DESTDIR}${MANPREFIX}/man1
- for m in $(MAN1); do chmod 644 ${DESTDIR}${MANPREFIX}/man1/$$m; done
+ mkdir -p ${DESTDIR}${MANPREFIX}/man8
+ cp -f ${MAN8} ${DESTDIR}${MANPREFIX}/man8
+ for m in $(MAN8); do chmod 644 ${DESTDIR}${MANPREFIX}/man8/$$m; done
uninstall:
# removing executable files.
for f in $(BIN); do rm -f ${DESTDIR}${PREFIX}/bin/$$f; done
-rmdir ${DESTDIR}${PREFIX}/share/${NAME}
# removing manual pages.
- for m in $(MAN1); do rm -f ${DESTDIR}${MANPREFIX}/man1/$$m; done
+ for m in $(MAN8); do rm -f ${DESTDIR}${MANPREFIX}/man8/$$m; done
.PHONY: all clean dist install uninstall
diff --git a/stun.8 b/stun.8
@@ -0,0 +1,44 @@
+.Dd Mar 22, 2016
+.Dt STUN 8
+.Os
+.Sh NAME
+.Nm stun
+.Nd simple tunnel
+.Sh SYNOPSIS
+.Nm stun
+.Op Fl df
+.Fl s
+.Op Fl p Ar port
+.Ar interface
+.Nm stun
+.Op Fl df
+.Fl h Ar host
+.Op Fl p Ar port
+.Ar interface
+.Sh DESCRIPTION
+.Nm
+is a simple point to point tunnelling program. IP addresses will need
+to be assigned to the tunnel
+.Ar interface
+in advance.
+.Sh OPTIONS
+.Bl -tag -width "-p port"
+.It Fl d
+Enable debug output.
+.It Fl f
+Run in foreground.
+.It Fl s
+Enable server mode. Default is off.
+.It Fl p Ar port
+Listen or connect to specified
+.Ar port .
+The default port is 12080.
+.It Fl h Ar host
+Connect to specified
+.Ar host .
+.El
+.Sh AUTHORS
+.An Dimitris Papastamos Aq Mt sin@2f30.org
+.Sh BUGS
+This program is an experiment and is currently not secure. Use at your
+own risk.
