Update man pages
This commit is contained in:
parent
78a39a6578
commit
5c8fdc6cf2
|
@ -1,4 +1,4 @@
|
|||
.TH dcd-client 1 "August 11 2014" "" https://github.com/Hackerpilot/DCD
|
||||
.TH dcd-client 1 "Oct 30 2015" "" https://github.com/Hackerpilot/DCD
|
||||
.SH NAME
|
||||
dcd-client \- autocompletion client for the D programming language
|
||||
.PD
|
||||
|
@ -11,7 +11,7 @@ dcd-client \- autocompletion client for the D programming language
|
|||
.OP "\-l, \-\-symbolLocation"
|
||||
.OP "\-s, \-\-search" symbolName
|
||||
.OP "\-d, \-\-doc"
|
||||
.OP "\-q, \-\-query"
|
||||
.OP "\-q, \-\-query, \-\-status"
|
||||
.OP "\-\-shutdown"
|
||||
.OP "\-\-clearCache"
|
||||
.OP "\-\-version"
|
||||
|
@ -66,7 +66,7 @@ can be found.
|
|||
.RS
|
||||
Gets documentation comments associated with the symbol at the cursor location.
|
||||
.RE
|
||||
.B \-q, \-\-query
|
||||
.B \-q, \-\-query, \-\-status
|
||||
.RS
|
||||
Query the server statis. Returns 0 if the server is running. Returns 1 if the
|
||||
server could not be contacted.
|
||||
|
|
|
@ -1,11 +1,12 @@
|
|||
.TH dcd-server 1 "March 6 2014" "" https://github.com/Hackerpilot/DCD
|
||||
.TH dcd-server 1 "Oct 30 2015" "" https://github.com/Hackerpilot/DCD
|
||||
.SH NAME
|
||||
dcd-server \- autocompletion server for the D programming language
|
||||
.PD
|
||||
.SH SYNOPSIS
|
||||
.SY dcd-server
|
||||
.OP \-I directory
|
||||
.OP \-p|\-\-port portNumber
|
||||
.OP \-I
|
||||
.OP \-\-logLevel level
|
||||
.OP \-h|\-\-help
|
||||
.OP \-\-version
|
||||
.YS
|
||||
|
@ -21,27 +22,44 @@ Choose the port number on which
|
|||
.B dcd-server
|
||||
listens.
|
||||
.RE
|
||||
.B -h, \-\-help
|
||||
.B \-\-logLevel
|
||||
.I level
|
||||
.RS
|
||||
Prints a help message.
|
||||
.RE
|
||||
.B \-\-version
|
||||
.RS
|
||||
Prints dcd-server's version number and exits.
|
||||
Configure the logging level for dcd-server. Valid values are
|
||||
.I all
|
||||
.I trace
|
||||
.I info
|
||||
.I warning
|
||||
.I error
|
||||
.I critical
|
||||
.I fatal
|
||||
.I off
|
||||
.RE
|
||||
.B \-I
|
||||
.I directory
|
||||
.RS
|
||||
Includes
|
||||
.I directory
|
||||
in the list of directories to scan for source files.
|
||||
in the list of directories to scan for source files. This option can be specified multiple times.
|
||||
.RE
|
||||
.B -h, \-\-help
|
||||
.RS
|
||||
Prints a help message.
|
||||
.RE
|
||||
.B \-\-version
|
||||
.RS
|
||||
Prints the current version number and exits.
|
||||
.RE
|
||||
.PD
|
||||
.SH FILES
|
||||
dcd-server can be configured through the use of a file called
|
||||
.B dcd-server
|
||||
can be configured through the use of a file called
|
||||
.I dcd.conf
|
||||
This file should be placed in one of the following locations:
|
||||
.IP \(bu
|
||||
.I /etc/dcd.conf
|
||||
.RE
|
||||
.IP \(bu
|
||||
.I $XDG_CONFIG_HOME/dcd/dcd.conf
|
||||
.RE
|
||||
.IP \(bu
|
||||
|
@ -54,7 +72,7 @@ is equivalent to passing that same line to
|
|||
.B dcd-server
|
||||
with the
|
||||
.I -I
|
||||
option.
|
||||
option. Lines that start with the '#' character are ignored.
|
||||
.SH AUTHOR
|
||||
Written by Brian Schott (@Hackerpilot on Github)
|
||||
.PD
|
||||
|
|
Loading…
Reference in New Issue