git @ Cat's Eye Technologies klaus / 7533709
Add klaus.1 manpage. Jelmer Vernooij 9 years ago
1 changed file(s) with 55 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
+55
-0
klaus.1 less more
0 .TH KLAUS "1" "December 2015" "klaus 4e82832" "User Commands"
1 .SH NAME
2 klaus \- easy to set up Git web viewer
3 .SH SYNOPSIS
4 .B klaus
5 [\fIOPTION\fR]... [\fIDIR\fR]...
6 .SH DESCRIPTION
7 Klaus is a simple and easy-to-set-up Git web viewer that Just Works\(tm.
8 .PP
9 Note that the klaus binary just starts a test instance. The klaus script uses
10 wsgiref internally which doesn't scale at all - it's single-threaded and
11 non-asynchronous.
12 .PP
13 It supports syntax highlighting and Git Smart HTTP.
14 .SH OPTIONS
15 .TP
16 \fB\-h\fR, \fB\-\-help\fR
17 show this help message and exit
18 .TP
19 \fB\-\-host\fR HOST
20 default: 127.0.0.1
21 .TP
22 \fB\-\-port\fR PORT
23 default: 8080
24 .TP
25 \fB\-\-site\-name\fR SITE_NAME
26 site name showed in header. default: your hostname
27 .TP
28 \fB\-\-version\fR
29 print version number
30 .TP
31 \fB\-b\fR, \fB\-\-browser\fR
32 open klaus in a browser on server start
33 .TP
34 \fB\-B\fR BROWSER, \fB\-\-with\-browser\fR BROWSER
35 specify which browser to use with \fB\-\-browser\fR
36 .TP
37 \fB\-\-ctags\fR {none,tags\-and\-branches,ALL}
38 enable ctags for which revisions? default: none.
39 WARNING: Don't use 'ALL' for public servers!
40 .SS "Git Smart HTTP:"
41 .TP
42 \fB\-\-smarthttp\fR
43 enable Git Smart HTTP serving
44 .TP
45 \fB\-\-htdigest\fR FILE
46 use credentials from FILE
47 .SS "Development flags:"
48 .IP
49 DO NOT USE IN PRODUCTION!
50 .TP
51 \fB\-\-debug\fR
52 Enable Werkzeug debugger and reloader
53 .SH AUTHORS
54 Copyright \(co 2011-2015 Jonas Haag <jonas@lophus.org> and contributors (see Git logs).