Add containers submodule. Add man files
This commit is contained in:
parent
cc0a91963a
commit
9e0ee133b5
|
@ -10,3 +10,6 @@
|
||||||
[submodule "datapicked"]
|
[submodule "datapicked"]
|
||||||
path = datapicked
|
path = datapicked
|
||||||
url = https://github.com/blackwhale/datapicked.git
|
url = https://github.com/blackwhale/datapicked.git
|
||||||
|
[submodule "containers"]
|
||||||
|
path = containers
|
||||||
|
url = https://github.com/economicmodeling/containers.git
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
Subproject commit d7ed9214326e0eb52916cdca3b0b59a9c2a7c0e0
|
|
@ -0,0 +1,72 @@
|
||||||
|
.TH dcd-client 1 "March 6 2014" "" https://github.com/Hackerpilot/DCD
|
||||||
|
.SH NAME
|
||||||
|
dcd-client \- autocompletion client for the D programming language
|
||||||
|
.PD
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.SY dcd-client
|
||||||
|
.OP "\-c, \-\-cursorPos" cursorPosition
|
||||||
|
.OP "\-p, \-\-port" portNumber
|
||||||
|
.OP "\-I" directory
|
||||||
|
.OP "\-h, \-\-help"
|
||||||
|
.OP "\-l, \-\-symbolLocation"
|
||||||
|
.OP "\-d, \-\-doc"
|
||||||
|
.OP "\-\-shutdown"
|
||||||
|
.OP "\-\-clearCache"
|
||||||
|
.RI [ filename ]
|
||||||
|
.YS
|
||||||
|
.PD
|
||||||
|
.SH DESCRIPTION
|
||||||
|
\fBdcd-client\fP is a client for \fBdcd-server\fP and is typically used by text
|
||||||
|
editor scripts.
|
||||||
|
.PD
|
||||||
|
.SH OPTIONS
|
||||||
|
.B -p, \-\-port
|
||||||
|
.I portNumber
|
||||||
|
.RS
|
||||||
|
Choose the port number on which
|
||||||
|
.B dcd-client
|
||||||
|
listens.
|
||||||
|
.RE
|
||||||
|
.B -h, \-\-help
|
||||||
|
.RS
|
||||||
|
Prints a help message
|
||||||
|
.RE
|
||||||
|
.B \-I
|
||||||
|
.I directory
|
||||||
|
.RS
|
||||||
|
Informs
|
||||||
|
.B dcd-server
|
||||||
|
to cache any D source files found in
|
||||||
|
.I directory
|
||||||
|
so that they will be included in responses to future
|
||||||
|
.B dcd-client
|
||||||
|
requests.
|
||||||
|
.RE
|
||||||
|
.B \-c, \-\-cursorPos
|
||||||
|
.I cursorPosition
|
||||||
|
.RS
|
||||||
|
Provides auto-completion at the given cursor position. The cursor
|
||||||
|
position is measured in bytes from the beginning of the source code.
|
||||||
|
.RE
|
||||||
|
.B \-\-shutdown
|
||||||
|
.RS
|
||||||
|
Instructs the server to shut down
|
||||||
|
.RE
|
||||||
|
.B \-\-clearCache
|
||||||
|
.RS
|
||||||
|
Instructs the server to clear its cache of auto-completion information.
|
||||||
|
.RE
|
||||||
|
.I filename
|
||||||
|
.RS
|
||||||
|
Provides auto-completion information for the file with the given name.
|
||||||
|
.RE
|
||||||
|
.PD
|
||||||
|
.SH AUTHOR
|
||||||
|
Written by Brian Schott (@Hackerpilot on Github)
|
||||||
|
.PD
|
||||||
|
.SH BUGS
|
||||||
|
Please use the issue tracker located at
|
||||||
|
.UR https://github.com/Hackerpilot/DCD/issues
|
||||||
|
.UE
|
||||||
|
.SH SEE ALSO
|
||||||
|
\fBdcd-server\fP(1)
|
|
@ -0,0 +1,61 @@
|
||||||
|
.TH dcd-server 1 "March 6 2014" "" https://github.com/Hackerpilot/DCD
|
||||||
|
.SH NAME
|
||||||
|
dcd-server \- autocompletion server for the D programming language
|
||||||
|
.PD
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.SY dcd-server
|
||||||
|
.OP \-p|\-\-port portNumber
|
||||||
|
.OP \-I
|
||||||
|
.OP \-h|\-\-help
|
||||||
|
.YS
|
||||||
|
.PD
|
||||||
|
.SH DESCRIPTION
|
||||||
|
\fBdcd-server\fP caches information about D source files that were found
|
||||||
|
.PD
|
||||||
|
.SH OPTIONS
|
||||||
|
.B -p, \-\-port
|
||||||
|
.I portNumber
|
||||||
|
.RS
|
||||||
|
Choose the port number on which
|
||||||
|
.B dcd-server
|
||||||
|
listens.
|
||||||
|
.RE
|
||||||
|
.B -h, \-\-help
|
||||||
|
.RS
|
||||||
|
Prints a help message
|
||||||
|
.RE
|
||||||
|
.B \-I
|
||||||
|
.I directory
|
||||||
|
.RS
|
||||||
|
Includes
|
||||||
|
.I directory
|
||||||
|
in the list of directories to scan for source files.
|
||||||
|
.RE
|
||||||
|
.PD
|
||||||
|
.SH FILES
|
||||||
|
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 $XDG_CONFIG_HOME/dcd/dcd.conf
|
||||||
|
.RE
|
||||||
|
.IP \(bu
|
||||||
|
.I $HOME/.config/dcd/dcd.conf
|
||||||
|
.RE
|
||||||
|
|
||||||
|
Each line in the file should be a path to search for D source files. A line in
|
||||||
|
.I dcd.conf
|
||||||
|
is equivalent to passing that same line to
|
||||||
|
.B dcd-server
|
||||||
|
with the
|
||||||
|
.I -I
|
||||||
|
option.
|
||||||
|
.SH AUTHOR
|
||||||
|
Written by Brian Schott (@Hackerpilot on Github)
|
||||||
|
.PD
|
||||||
|
.SH BUGS
|
||||||
|
Please use the issue tracker located at
|
||||||
|
.UR https://github.com/Hackerpilot/DCD/issues
|
||||||
|
.UE
|
||||||
|
.SH SEE ALSO
|
||||||
|
\fBdcd-client\fP(1)
|
Loading…
Reference in New Issue