aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormutantturkey <mutantturke@gmail.com>2013-03-05 10:04:08 -0500
committermutantturkey <mutantturke@gmail.com>2013-03-05 10:04:08 -0500
commite2f527c3f0e557b6d59d8c6884d9ae1666a93109 (patch)
tree52bc310744520868e6e1d4f6490d8b05f4b5a561
parent810f378ff8ce79ef220da92dad9bc837a8ecb925 (diff)
Added a basic man file for svte
I have created a basic man file for svte, it is very basic but gives all the basic information needed. Has shortcuts, command line args, and important files. More might be needed later. Still need to modify the Makefile.
-rw-r--r--svte.145
1 files changed, 45 insertions, 0 deletions
diff --git a/svte.1 b/svte.1
new file mode 100644
index 0000000..cb6eb3b
--- /dev/null
+++ b/svte.1
@@ -0,0 +1,45 @@
+.TH SVTE 1 svte\-VERSION
+.SH NAME
+svte \- simple virtual terminal emulator
+.SH SYNOPSIS
+.B svte
+.RB [ \-c
+.IR config-file ]
+.RB [ \-e
+.IR execute ]
+.RB [ \-v ]
+.P
+.BR svte " ..."
+.SH DESCRIPTION
+.B svte
+svte is a terminal that is flexible and has a small codebase. Its aim is to be
+lightweight and fast, while providing nice integration with a modern Linux
+environment. svte is yet another minimal GTK incarnation of VTE.
+.P
+.SH OPTIONS
+.TP
+.B \-c, --config-file
+use the config file provided by this argument instead of the default (~/.svterc)
+.TP
+.B \-e, --execute
+svte will launch indicated program instead of the users default shell. xterm
+style.
+.TP
+.B \-v, --version
+print current version
+.SH USAGE
+svte is completely controlled by the keyboard. The shortcuts are not yet
+configurable.
+.TP
+.B Ctrl + Shift + t
+Open a new tab.
+.TP
+.B Ctrl + Shift + n
+Open a new window.
+.TP
+.B Ctrl + Shift + w
+Close current tab, if there is only one tab, close the window
+.SH FILES
+.TP
+.I /home/$USER/.svtrc
+The default svte config file that svte will attempt to read.