.\" This file is generated automatically by convert.pl from htags-server/manual.in.
.TH HTAGS-SERVER 1 "November 2016" "GNU Project"
.SH NAME
htags\-server - a private Web/CGI server for htags
.SH SYNOPSIS
\fBhtags-server\fP [-b ip-address][-u language][--retry[=n]][\fIport\fP]
.br
.SH DESCRIPTION
\fBHtags-server\fP is a private Web/CGI server for the hyper-text
generated by \fBhtags\fP(1).
.PP
In advance of using this command, you should execute \fBhtags\fP(1).
Then you can execute htags-server at the same place.
You can start browsing at 'http://localhost:8000/' by default.
To stop the server, just press on 'CTRL-C'.
.PP
Python 2/3 or Ruby equipped with WEBrick is required.
By default, \fBhtags-server\fP looks for python first, if not found then
looks for ruby.
.SH OPTIONS
The following options are available:
.TP
\fB-b\fP, \fB--bind\fP \fIip-address\fP
Specifies the IP address on which \fBhtags-server\fP listen.
The default value is 127.0.0.1.
.TP
\fB-u\fP, \fB--use\fP \fIlanguage\fP
Specifies language to use, which may be one of: \'python\' and \'ruby\'.
.TP
\fB--retry\fP[=\fIn\fP]
If the port is already in use, retry \fIn\fP times with incrementing the \fIport\fP number. The default of \fIn\fP is 20.
.TP
\fIport\fP
Specifies the port on which \fBhtags-server\fP listen.
If you want to use multiple sessions, you must use unique number
for each \fBhtags-server\fP. The default value is 8000.
.SH EXAMPLES
.nf
$ gtags
$ htags --suggest2
$ htags-server
Python2 http/cgi server
Serving HTTP on 127.0.0.1 port 8000 ...
.PP
(another terminal)
$ firefox http://localhost:8000/
.PP
$ htags-server
Error: port 8000 already in use.
$ htags-server --retry
Warning: port 8000 already in use (skipped)
Please access at http://127.0.0.1:8001
Python2 http/cgi server
Serving HTTP on 127.0.0.1 port 8001 ...
.fi
.SH DIAGNOSTICS
\fBHtags-server\fP exits with a non-0 value if an error occurred, 0 otherwise.
.SH "SEE ALSO"
\fBglobal\fP(1),
\fBgtags\fP(1),
\fBhtags\fP(1),
\fBpython\fP(1),
\fBruby\fP(1).
.PP
GNU Global source code tag system
.br
(http://www.gnu.org/software/global/).
.SH AUTHOR
Shigio YAMAGUCHI.
.SH HISTORY
The \fBhtags-server\fP command appeared in Global-6.3 (2014).