| 1 |
<HTML> |
| 2 |
<!-- this file was generated by troffcvt and tc2html --> |
| 3 |
<HEAD> |
| 4 |
<TITLE> |
| 5 |
lsdistcc manual page |
| 6 |
</TITLE> |
| 7 |
</HEAD> |
| 8 |
<BODY> |
| 9 |
<H1> |
| 10 |
lsdistcc manual page<BR> |
| 11 |
</H1> |
| 12 |
<P> |
| 13 |
<H2> |
| 14 |
Table of Contents |
| 15 |
</H2> |
| 16 |
<!-- INSERT TOC HERE, MAYBE --> |
| 17 |
<!-- TOC BEGIN --> |
| 18 |
<UL> |
| 19 |
<LI> |
| 20 |
<A HREF=#TOC_1> NAME</A> |
| 21 |
<LI> |
| 22 |
<A HREF=#TOC_2> SYNOPSIS</A> |
| 23 |
<LI> |
| 24 |
<A HREF=#TOC_3> DESCRIPTION</A> |
| 25 |
<LI> |
| 26 |
<A HREF=#TOC_4> OPTIONS</A> |
| 27 |
<LI> |
| 28 |
<A HREF=#TOC_5> EXAMPLES</A> |
| 29 |
<LI> |
| 30 |
<A HREF=#TOC_6> EXIT STATUS</A> |
| 31 |
<LI> |
| 32 |
<A HREF=#TOC_7> SEE ALSO</A> |
| 33 |
<LI> |
| 34 |
<A HREF=#TOC_8> AUTHOR</A> |
| 35 |
</UL> |
| 36 |
<!-- TOC END --> |
| 37 |
<BR> |
| 38 |
<H2> |
| 39 |
<A NAME=TOC_1> |
| 40 |
NAME</A> |
| 41 |
</H2> |
| 42 |
lsdistcc - simple distcc server discovery<BR> |
| 43 |
<H2> |
| 44 |
<A NAME=TOC_2> |
| 45 |
SYNOPSIS</A> |
| 46 |
</H2> |
| 47 |
<B>lsdistcc</B> [<I>OPTIONS</I>] [<I>FORMAT</I>]<BR> |
| 48 |
<P> |
| 49 |
<B>lsdistcc</B> [<I>OPTIONS</I>] <I> host1 ...</I><BR> |
| 50 |
<H2> |
| 51 |
<A NAME=TOC_3> |
| 52 |
DESCRIPTION</A> |
| 53 |
</H2> |
| 54 |
<B>lsdistcc</B> autodetects listening distcc servers either by |
| 55 |
looking in DNS for hosts named according to a given <I>FORMAT</I>, |
| 56 |
or by checking the host names given on the command line.<BR> |
| 57 |
Hosts are considered good servers based solely on whether their |
| 58 |
name fits the format and whether they are listening on the right |
| 59 |
port (and optionally whether they respond when you send them a |
| 60 |
compile job).<BR> |
| 61 |
Scans for hosts named according to <I> FORMAT</I> (default is |
| 62 |
"distcc%d"; see <B>printf</B>(3)) and starting from |
| 63 |
1, so hosts such as distcc1, distcc2, and so on. Stops after 7 |
| 64 |
seconds or the first host name that does not resolve. Prints the |
| 65 |
names of all such servers listening on distcc's port.<BR> |
| 66 |
If a list of host names is given in the command line, <B> lsdistcc</B> |
| 67 |
will only check those hosts.<BR> |
| 68 |
<H2> |
| 69 |
<A NAME=TOC_4> |
| 70 |
OPTIONS</A> |
| 71 |
</H2> |
| 72 |
<BR> |
| 73 |
<DL> |
| 74 |
<DT> |
| 75 |
<B>--help</B> |
| 76 |
</DT> |
| 77 |
<DD> |
| 78 |
Displays summary instructions<BR> |
| 79 |
</DD> |
| 80 |
<DT> |
| 81 |
<B>-l</B> |
| 82 |
</DT> |
| 83 |
<DD> |
| 84 |
Output latency in milliseconds after each hostname (not including |
| 85 |
DNS latency)<BR> |
| 86 |
</DD> |
| 87 |
<DT> |
| 88 |
<B>-n</B> |
| 89 |
</DT> |
| 90 |
<DD> |
| 91 |
Print IP address rather than name<BR> |
| 92 |
</DD> |
| 93 |
<DT> |
| 94 |
<B>-x</B> |
| 95 |
</DT> |
| 96 |
<DD> |
| 97 |
Append ,down to down hosts in host list<BR> |
| 98 |
</DD> |
| 99 |
<DT> |
| 100 |
<B>-t</B><I>TIMEOUT</I> |
| 101 |
</DT> |
| 102 |
<DD> |
| 103 |
Set number of seconds to stop searching after [7]<BR> |
| 104 |
</DD> |
| 105 |
<DT> |
| 106 |
<B>-h</B><I>HTIMEOUT</I> |
| 107 |
</DT> |
| 108 |
<DD> |
| 109 |
Set number of milliseconds before retrying gethostbyname [500]<BR> |
| 110 |
</DD> |
| 111 |
<DT> |
| 112 |
<B>-c</B><I>CTIMEOUT</I> |
| 113 |
</DT> |
| 114 |
<DD> |
| 115 |
Set number of milliseconds before giving up on connect [900] (0 |
| 116 |
to inhibit connect)<BR> |
| 117 |
</DD> |
| 118 |
<DT> |
| 119 |
<B>-k</B><I>KTIMEOUT</I> |
| 120 |
</DT> |
| 121 |
<DD> |
| 122 |
Set number of milliseconds before giving up on compile [1500] |
| 123 |
(0 to inhibit compile)<BR> |
| 124 |
</DD> |
| 125 |
<DT> |
| 126 |
<B>-m</B><I>BITS</I> |
| 127 |
</DT> |
| 128 |
<DD> |
| 129 |
Set number of bits of address that must match first host found |
| 130 |
[0]<BR> |
| 131 |
</DD> |
| 132 |
<DT> |
| 133 |
<B>-o</B><I>OVERLAP</I> |
| 134 |
</DT> |
| 135 |
<DD> |
| 136 |
Set number of extra DNS requests to send [1]<BR> |
| 137 |
</DD> |
| 138 |
<DT> |
| 139 |
<B>-g</B><I>DNSGAP</I> |
| 140 |
</DT> |
| 141 |
<DD> |
| 142 |
Set number of missing DNS entries to tolerate [0]<BR> |
| 143 |
</DD> |
| 144 |
<DT> |
| 145 |
<B>-r</B><I>PORT</I> |
| 146 |
</DT> |
| 147 |
<DD> |
| 148 |
Port to connect to [3632]<BR> |
| 149 |
</DD> |
| 150 |
<DT> |
| 151 |
<B>-P</B><I>PROTOCOL</I> |
| 152 |
</DT> |
| 153 |
<DD> |
| 154 |
Protocol version to use (1-3) [1]<BR> |
| 155 |
</DD> |
| 156 |
<DT> |
| 157 |
<B>-p</B><I>COMPILER</I> |
| 158 |
</DT> |
| 159 |
<DD> |
| 160 |
Name of compiler to use [none]<BR> |
| 161 |
</DD> |
| 162 |
<DT> |
| 163 |
<B>-d</B> |
| 164 |
</DT> |
| 165 |
<DD> |
| 166 |
Append DNS domain name to format<BR> |
| 167 |
</DD> |
| 168 |
<DT> |
| 169 |
<B>-v</B> |
| 170 |
</DT> |
| 171 |
<DD> |
| 172 |
Verbose<BR> |
| 173 |
</DD> |
| 174 |
</DL> |
| 175 |
<H2> |
| 176 |
<A NAME=TOC_5> |
| 177 |
EXAMPLES</A> |
| 178 |
</H2> |
| 179 |
Scan for servers named distcc1, distcc2, ... that provide a compiler |
| 180 |
named gcc-4.6 and include their latencies in the output:<BR> |
| 181 |
<UL> |
| 182 |
$ lsdistcc -l -pgcc-4.6<BR> |
| 183 |
</UL> |
| 184 |
Scan for a compiler named gcc-4.6 on the servers hosta, somehost, |
| 185 |
hostx, and hosty:<BR> |
| 186 |
<UL> |
| 187 |
$ lsdistcc -pgcc-4.6 hosta somehost hostx hosty<BR> |
| 188 |
</UL> |
| 189 |
To use the program in a build script, add the lines:<BR> |
| 190 |
<UL> |
| 191 |
DISTCC_HOSTS='lsdistcc'<BR> |
| 192 |
export DISTCC_HOSTS<BR> |
| 193 |
</UL> |
| 194 |
before the line that invokes make. Or, in a Makefile, add the |
| 195 |
line:<BR> |
| 196 |
<UL> |
| 197 |
export DISTCC_HOSTS = $(shell lsdistcc)<BR> |
| 198 |
</UL> |
| 199 |
Or use <B>pump</B>(1) which automatically invokes lsdistcc if |
| 200 |
you set DISTCC_POTENTIAL_HOSTS.<BR> |
| 201 |
<H2> |
| 202 |
<A NAME=TOC_6> |
| 203 |
EXIT STATUS</A> |
| 204 |
</H2> |
| 205 |
The exit status is 0 if any servers were found, and 1 otherwise.<BR> |
| 206 |
Uses 'for i=1... sprintf(format, i)' to construct names of servers, |
| 207 |
stops after 7 seconds or at second server that doesn't resolve, |
| 208 |
prints the names of all such servers listening on distcc's port. |
| 209 |
Default format is distcc%d.<BR> |
| 210 |
<H2> |
| 211 |
<A NAME=TOC_7> |
| 212 |
SEE ALSO</A> |
| 213 |
</H2> |
| 214 |
<B>distcc</B>(1), <B>distccd</B>(1), <B>pump</B>(1), <B>printf</B>(3)<BR> |
| 215 |
<I>http://code.google.com/p/distcc/</I><BR> |
| 216 |
<H2> |
| 217 |
<A NAME=TOC_8> |
| 218 |
AUTHOR</A> |
| 219 |
</H2> |
| 220 |
<B>lsdistcc</B> was written by Dan Kegel, Dongmin Zhang, and Manos |
| 221 |
Renieris.<BR> |
| 222 |
This manual page was written by Daniel Hartwig for the Debian |
| 223 |
project.<BR> |
| 224 |
</BODY> |
| 225 |
</HTML> |