1dircproxy(1)                General Commands Manual               dircproxy(1)
2
3
4

NAME

6       dircproxy - Detachable Internal Relay Chat Proxy Server
7
8

SYNOPSIS

10       dircproxy [-hvDI] [-f config_file] [-P listen_port] [-p pid_file]
11
12

DESCRIPTION

14       dircproxy  is  an IRC proxy server designed for people who use IRC from
15       lots of different workstations or clients, but wish to remain connected
16       and see what they missed while they were away.
17
18       You connect to IRC through dircproxy, and it keeps you connected to the
19       server, even after you  detach  your  client  from  it.   While  you're
20       detached,  it  logs  channel  and private messages as well as important
21       events, and when you re-attach it'll let you know what you missed.
22
23       This can be used to give you roughly the same  functionality  as  using
24       ircII  and  screen(8)  together, except you can use whatever IRC client
25       you like, including X ones!
26
27       Authentication is provided by a password, and optional hostname  check‐
28       ing.   This  links it to a connection class specified in the configura‐
29       tion file.  Only one user may use a connection class at one time,  when
30       that  user  detaches,  the connection to the server is kept open.  When
31       someone (usually the user) subsequently connects to dircproxy and  pro‐
32       vides  the same password, they are reconnected to the connection to the
33       server, instead of having a new connection created for them.
34
35       Multiple connection classes can be defined, allowing multiple people to
36       use the same proxy.
37
38       dircproxy  can use either a .dircproxyrc file in the user's home direc‐
39       tory, or a system-wide dircproxyrc file.  It will  load  the  first  it
40       finds  (home  directory  first, then system-wide).  If no configuration
41       file is specified, it will not start.
42
43

OPTIONS

45       -f config_file
46              Specifies the configuration file  to  be  used,  overriding  the
47              default search list.
48
49       -h     Displays  a  brief help message detailing the command-line argu‐
50              ments, then exits.
51
52       -v     Displays the dircproxy version number, then exits.
53
54       -D     Run in the foreground and do not fork into the background.
55
56       -I     Use to indicate dircproxy is being run from the inetd(8) daemon.
57              This  implies  -D.   For  more  information on running dircproxy
58              under inetd(8), see the README.inetd file.
59
60       -P listen_port
61              Specifies an alternate port to use, overriding the  default  and
62              any  value specified in the configuration file. You can also add
63              the IP-address of the adapter you want  dircproxy  to  bind  to,
64              e.g.: 192.168.64.1:7007
65
66       -p pid_file
67              Specifies  a  file  to  write  the process id to, overriding the
68              default and any value specified in the configuration file.
69
70

CONFIGURATION

72       The configuration file has the following format:
73
74       Empty lines and lines starting with '#' are comments.
75
76       Connection classes start with 'connection {' and end  with  '}'.   They
77       obtain default values from all the entries above them in the configura‐
78       tion file, and may contain values of their own.
79
80       Otherwise a line is of the format 'keywords arguments'.  If  the  argu‐
81       ment  contains  spaces  it should be contained in double quotes ('"with
82       spaces"').  The possible keywords and their  meanings  are  as  follows
83       (note that the configuration file is not case-sensitive):
84
85
86       GLOBAL OPTIONS
87
88       These  options  may  not  be  placed  inside a connection class as they
89       affect the operation of the entire dircproxy server.
90
91
92       listen_port
93              What port should  dircproxy  listen  for  connections  from  IRC
94              clients on?
95
96              This  can  be  a  numeric  port  number,  or a service name from
97              /etc/services.  You can also enter the IP-address of the adapter
98              you want dircproxy to bind to, e.g.: 192.168.64.1:7007
99
100
101       pid_file
102              File  to  write  the dircproxy process id to on startup.  If you
103              start this with a "~/" then it refers to a file in  a  directory
104              under your home directory.
105
106               none = Don't write pid file
107
108
109       client_timeout
110              Maxmimum  amount  of time (in seconds) a client can take to con‐
111              nect to dircproxy and provide their password and nickname etc.
112
113
114       connect_timeout
115              Maximum amount of time (in seconds) a client has  to  provide  a
116              server to connect to after they've logged in.  This only applies
117              if 'server_autoconnect' is 'no' for that class.
118
119
120       dns_timeout
121              Maximum amount of time (in seconds) to wait for a reply  from  a
122              DNS  server.   If  the time exceeds this then the lookup is can‐
123              celled.
124
125
126       LOCAL OPTIONS
127
128       These options may be placed in a connection class, or outside  of  one.
129       If  they  are  outside  then  they only affect those connection classes
130       defined afterwards.
131
132
133       SERVER OPTIONS
134
135       Options affecting the connection to the IRC server.
136
137
138       server_port
139              What port do we connect to IRC servers on if the  server  string
140              doesn't explicitly set one
141
142              This  can  be  a  numeric  port  number,  or a service name from
143              /etc/services
144
145
146       server_retry
147              How many seconds after disconnection or last connection  attempt
148              do we wait before retrying again?
149
150
151       server_maxattempts
152              If we are disconnected from the server, how many times should we
153              iterate the server list before giving up and declaring the prox‐
154              ied connection dead?
155
156              0 = iterate forever
157
158
159       server_maxinitattempts
160              On first connection, how many times should we iterate the server
161              list before giving up and declaring the proxied connection dead?
162
163               0 = iterate forever.  This isn't recommended.
164
165
166       server_keepalive
167              This checks whether the dircproxy to server connection is  alive
168              at  the TCP level.  If no data is sent in either direction for a
169              period of time, a TCP keepalive probe is sent.
170
171               yes = send keepalive probes
172               no = don't send keepalive probes
173
174
175       server_pingtimeout
176              For some people, dircproxy doesn't notice that the connection to
177              the  server  has  been  dropped because the socket remains open.
178              For example, those behind a NAT'd firewall.  dircproxy can  ping
179              the  server  and  make  sure  it gets replies back.  If the time
180              since the last reply was received exceeds the number of  seconds
181              below  the server is assumed to be "stoned" and dircproxy leaves
182              it.  If you have a high latency connection to the server, it can
183              wrongly  assume  the  server  is  stoned because the PINGs don't
184              arrive  in  time.   Either  raise  the   value,   or   use   the
185              'server_keepalive' option instead.
186
187
188               0 = don't send PINGs
189
190
191       server_throttle
192              To prevent you from being flooded off the IRC network, dircproxy
193              can throttle the connection to the server to  prevent  too  much
194              being sent within a certain time period.
195
196              For  this  you specify a number of bytes, then optionally a time
197              period in seconds seperated by a colon.  If the time  period  is
198              ommitted then per second is assmued.
199
200               server_throttle 10        # 10 bytes per second
201               server_throttle  10:2      # 10 bytes per 2 seconds (5 per sec‐
202              ond)
203
204               0 = do not throttle the connection
205
206
207       server_autoconnect
208              Should dircproxy automatically connect to the  first  server  in
209              the  list  when  you  connect.   If  you  set this to 'no', then
210              'allow_jump' is automatically set to 'yes'.  If 'allow_jump_new'
211              is  also  'yes',  then you can create connection classes with no
212              'server' lines.
213
214               yes = Automatically connect to the first server
215               no = Wait for a /DIRCPROXY JUMP from the client
216
217
218       CHANNEL OPTIONS
219
220       Options affecting channels you join.
221
222
223       channel_rejoin
224              If we are kicked off a channel, how  many  seconds  do  we  wait
225              before attempting to rejoin.
226
227               -1 = Don't rejoin
228               0 = Immediately
229
230
231       channel_leave_on_detach
232              Should  dircproxy  automatically make you leave all the channels
233              you were on when you detach?
234
235               yes = Leave them
236               no = Remain on them
237
238
239       channel_rejoin_on_attach
240              If 'channel_leave_on_detach'  is  'yes'  then  should  dircproxy
241              rejoin those channels when you attach again?
242
243               yes = Rejoin the channels dircproxy automatically left
244               no = Leave permanently on detach
245
246
247       IDLE OPTIONS
248
249       Options affecting idle times on IRC.
250
251
252       idle_maxtime
253              Set  this  to the maximum amount of time you want to appear idle
254              for while on IRC, if you set this then dircproxy will reset your
255              idle time if it reaches this limit (in seconds).
256
257               0 = Don't reset idle time
258
259
260       DISCONNECTiON OPTIONS
261
262       Options affecting when dircproxy disconnects you.
263
264
265
266       disconnect_existing_user
267              If,  when  you  connect  to  dircproxy, another client is
268              already using your connection class (ie, if you forgot to
269              close  that one), then this option lets you automatically
270              kill that one off.  Make sure  you  turn  any  "automatic
271              reconnect  to server" options off before using this, oth‐
272              erwise you'll have a fight on your hands.
273
274               yes = Yes, disconnect
275               no = No, don't let me on
276
277
278       disconnect_on_detach
279              When you detach from dircproxy it usually keeps you  con‐
280              nected  to  the  server  until you connect again.  If you
281              don't want this, and you want it  to  close  your  server
282              connection as well, then set this.
283
284               yes = Close session on disconnection
285               no = Stay connected to server until reattachment
286
287
288       MODE OPTIONS
289
290       Options affecting user modes set by the IRC server.
291
292
293       initial_modes
294              Which  user  modes  should  we automatically set when you
295              first connect to a server.  Just in case you forget to do
296              it yourself with your irc client.
297
298              Set to "" to not set any modes.
299
300
301       drop_modes
302              Which  user  modes to drop automatically when you detach,
303              handy to limit the impact that your client has while con‐
304              nected, or for extra security if you're an IRCop.
305
306              Set to "" to not drop any modes.
307
308
309       refuse_modes
310              Which  user  modes to refuse to accept from a server.  If
311              the server attempts to set one of these, then the connec‐
312              tion  to  it  will  be dropped and the next server in the
313              list will be tried.
314
315              A good setting for many people would  be  "+r",  as  most
316              servers  use  that to mean your connection is restricted.
317              Don't set it to this if you're on DALnet however,  DALnet
318              uses  +r  to  indicate  you have registered with NickServ
319              (gee, thanks guys!).
320
321              Set to "" to not refuse any modes.
322
323
324       ADDRESS OPTIONS
325
326       Options affecting your address on IRC.
327
328
329       local_address
330              Local hostname to use when connecting to an  IRC  server.
331              This  provides  the  same  functionality  as the ircII -H
332              parameter.
333
334               none = Do not bind any specific hostname
335
336
337       MESSAGE OPTIONS
338
339       Options affecting messages sent or set by dircproxy on behalf of
340       you.
341
342
343       away_message
344              If  you  don't explicitly set an /AWAY message before you
345              detach, dircproxy can for you, so people don't think  you
346              are really at your keyboard when you're not.
347
348               none = Do not set an away message for you
349
350
351       quit_message
352              If   you   don't  explicitly  give  a  message  when  you
353              /DIRCPROXY QUIT, this will be used  instead.   Also  used
354              for  when you've sent dircproxy not to remain attached to
355              the server on detachment.
356
357               none = Use dircproxy version number as QUIT message
358
359
360       attach_message
361              dircproxy can send an announcement onto every channel you
362              are on when you reattach to it, just to let everyone know
363              you are back.  If you start this with "/ME " then it will
364              be  sent  as  an ACTION CTCP message (just like the ircII
365              /me command).
366
367               none = Do not announce attachment
368
369
370       detach_message
371              dircproxy can send an announcement onto every channel you
372              are on when you detach from it, just to let everyone know
373              you are gone.  If you start this with "/ME " then it will
374              be  sent  as  an ACTION CTCP message (just like the ircII
375              /me command).
376
377               none = Do not announce detachment
378
379
380       detach_nickname
381              Nickname to change to automatically after you detach,  to
382              indicate  you  are  away for example.  If this contains a
383              '*' character,  then  that  character  is  replaced  with
384              whataver  your  nickname  was  before  you  detached  (ie
385              "*_away" adds "_away" to the end of your nickname);
386
387               none = Leave nickname as it is
388
389
390       NICKNAME OPTIONS
391
392       Options affecting your nickname
393
394
395       nick_keep
396              Whether dircproxy should attempt to keep the nickname you
397              last  set  using  your client.  If this is 'yes' and your
398              nickname is lost while your client is disconnected,  then
399              it will keep on trying to get it back until a client con‐
400              nects again.
401
402               yes = try to keep my nickname while I'm disconnected
403               no = if it changes, leave it
404
405
406       CTCP OPTIONS
407
408       Options affecting CTCP replies
409
410
411       ctcp_replies
412              Whether dircproxy should reply to  the  standard  set  of
413              CTCP messages while the client is detached.
414
415               yes = reply to ctcp messages while client is detached
416               no = nothing but silence
417
418
419       LOGGING OPTIONS
420
421       These  options affect both the internal logging inside dircproxy
422       so messages can be recalled to you when you  return  from  being
423       disconnected, and general logging for your own personal use.
424
425
426       log_timestamp
427              Log  messages  can have a timestamp added to the front to
428              let you know exactly when a message was logged.  The for‐
429              mat of this timestamp depends on the setting of 'log_rel‐
430              ativetime'.
431
432               yes = Include a timestamp in all log messages
433               no = Do not include a timestamp
434
435
436       log_relativetime
437              If 'log_timestamp' is 'yes' then you have the  option  of
438              using either intelligent relative timestamps, or ordinary
439              fixed timestamps.  If you choose relative, then the time‐
440              stamp  shown  when  log  information  is recalled to your
441              client depends on how old that  line  is,  with  possible
442              date  information  if it is a really old message.  If you
443              do not choose relative then only the time (in HH:MM  for‐
444              mat) will be logged.
445
446              This  obviously  has no effect on the log files under the
447              directory specified by 'log_dir'.
448
449               yes = Use relative timestamps
450               no = Use fixed timestamps
451
452
453       log_timeoffset
454              Difference  in  minutes  from  your  IRC  client  to  the
455              dircproxy  machine.   So  if  you're  in  GMT,  but  your
456              dircproxy machine is in PST (which is  8  hours  behind),
457              then  this would be -(8 * 60) = -480.  Used to adjust log
458              file timestamps so they're in the  right  time  zone  for
459              you.
460
461               0 = Don't adjust log timestamps.
462
463
464       log_events
465              Events  you  want  dircproxy  to  log for you.  This is a
466              comma seperated list of event names, prefixed with '+' to
467              add the event to the list or '-' to remove an event.  You
468              can also specify 'all' to log all events (the default) or
469              'none' to not log anything.
470
471              Example, to just log text and action's:
472
473               log_events "none,+text,+action"
474
475              Example, to log everything but server messages:
476
477               log_events "all,-server"
478               # you don't need to specify 'all'
479               log_events -server
480
481              The possible events are:
482
483              text
484               Channel text and private messages
485
486              action
487               CTCP ACTION events (/me) sent to you or channels
488
489              ctcp
490               Whether to record whether a CTCP was sent to you
491
492              join
493               People (including you) joining channels
494
495              part
496               People (including you) leaving channels
497
498              kick
499               People (including you) being kicked from channels
500
501              quit
502               People quit'ing from IRC
503
504              nick
505               People (including you) changing nickname
506
507              mode
508               Changes in channel modes or your own personal mode
509
510              topic
511               Changes to the channel topic
512
513              client
514               You detaching and attaching
515
516              server
517               Connections and disconnections from servers
518
519              error
520               Problems and errors dircproxy encounters (recommended!)
521
522
523       log_dir
524              dircproxy  keeps it's own internal log files (under /tmp)
525              so it can recall information  to  your  client  when  you
526              reconnect.   It  can  also log messages to files for your
527              own use.
528
529              Under this directory a file will be created  named  after
530              each channel you join, a file will be created named after
531              each nickname that sends you  private  messages,  or  you
532              send,  and  a  final file called "server" will be created
533              containing server events.
534
535              This logging is done regardless of the enabled or  always
536              settings,  which  only affect the internal logging.  How‐
537              ever the log_events settings do affect what is logged.
538
539              If you start with "~/" then it will use a directory under
540              your home directory.
541
542               none = Do not create log files for your own use
543
544
545       log_program
546              Program  to  pipe log messages into.  If given, dircproxy
547              will run this program for each  log  message  giving  the
548              full source information as the first argument, the desti‐
549              nation as the second and the message itself as  a  single
550              line on standard input.
551
552              The  program  can  be  anywhere in your $PATH, or you can
553              start it with "~/" if its in a directory under your  home
554              directory.
555
556              This  logging is done regardless of the enabled or always
557              settings, which only affect the internal  logging.   How‐
558              ever the log_events settings do affect what is logged.
559
560               none = Do not pipe log messages to a program
561
562
563       INTERNAL CHANNEL LOG OPTIONS
564
565       Options affecting the internal logging of channel text so it can
566       be recalled to your client when you  reconnect.   These  options
567       only apply if the 'chan_log_enabled' option is set to 'yes'.
568
569
570       chan_log_enabled
571              Whether  logging of channel text for later recall, so you
572              can see what you missed, should take place.
573
574               yes = Channel text is logged for recall
575               no = Channel text is NOT logged for recall
576
577
578       chan_log_always
579              Channel text will always be logged for later recall while
580              you  are  offline, so when you come back you can see what
581              you missed.  You can also, if you wish, log channel  text
582              while you are online, so if you're only away a short time
583              you can get an idea of any context.
584
585               yes = Log channel text  for  recall  while  offline  and
586              online
587               no = Log channel text for recall only while offline
588
589
590       chan_log_maxsize
591              To  preserve  your harddisk space, you can limit the size
592              of the internal channel log file, which is stored in  the
593              /tmp directory.  Once the log file reaches this number of
594              lines, every line added  will  result  in  a  line  being
595              removed from the top.  If you know you are never going to
596              want all that logged information, this might  be  a  good
597              setting for you.
598
599               0 = No limit to internal log file size
600
601
602       chan_log_recall
603              Number  of lines from the bottom of each internal channel
604              log to automatically recall to your IRC client  when  you
605              reconnect.   If  this is low, you may not get much useful
606              information, if this is high, it may take a long time for
607              all the information to arrive.
608
609               -1   =   Recall   the  whole  log  (not  recommended  if
610              chan_log_always is yes)
611               0 = Don't automatically recall anything
612
613
614       INTERNAL PRIVATE LOG OPTIONS
615
616       Options affecting the  internal  logging  of  private  messages,
617       notices,  CTCP  and  DCC  events so they can be recalled to your
618       client when you reconnect.  These  options  only  apply  if  the
619       'private_log_enabled' option is set to 'yes'.
620
621
622       private_log_enabled
623              Whether  logging of private messages for later recall, so
624              you can see what you missed, should take place.
625
626               yes = Private messages are logged for recall
627               no = Private messages are NOT logged for recall
628
629
630       private_log_always
631              Private messages will always be logged for  later  recall
632              while  you are offline, so when you come back you can see
633              what you missed.  You can also, if you wish, log  private
634              messages  while  you are online, so if you're only away a
635              short time you can get an idea of any context.
636
637               yes = Log private messages for recall while offline  and
638              online
639               no = Log private messages for recall only while offline
640
641
642       private_log_maxsize
643              To  preserve  your harddisk space, you can limit the size
644              of the internal private message log file, which is stored
645              in  the  /tmp  directory.  Once the log file reaches this
646              number of lines, every line added will result in  a  line
647              being  removed  from  the top.  If you know you are never
648              going to want all that logged information, this might  be
649              a good setting for you.
650
651               0 = No limit to internal log file size
652
653
654       private_log_recall
655              Number  of  lines from the bottom of the internal private
656              message log to automatically recall to  your  IRC  client
657              when you reconnect.  If this is low, you may not get much
658              useful information, if this is high, it may take  a  long
659              time for all the information to arrive.
660
661               -1  =  Recall  the  whole  log  (not recommended if pri‐
662              vate_log_always is yes)
663               0 = Don't automatically recall anything
664
665
666       INTERNAL SERVER LOG OPTIONS
667
668       Options affecting the internal logging  of  server  messages  so
669       they  can  be recalled to your client when you reconnect.  These
670       options only apply if the 'server_log_enabled' option is set  to
671       'yes'.
672
673
674       server_log_enabled
675              Whether  logging  of server messages for later recall, so
676              you can see what you missed, should take place.
677
678               yes = Server messages are logged for recall
679               no = Server messages are NOT logged for recall
680
681
682       server_log_always
683              Server messages will always be logged  for  later  recall
684              while  you are offline, so when you come back you can see
685              what you missed.  You can also, if you wish,  log  server
686              messages  while  you are online, so if you're only away a
687              short time you can get an idea of any context.
688
689               yes = Log server messages for recall while  offline  and
690              online
691               no = Log server messages for recall only while offline
692
693
694       server_log_maxsize
695              To  preserve  your harddisk space, you can limit the size
696              of the internal server message log file, which is  stored
697              in  the  /tmp  directory.  Once the log file reaches this
698              number of lines, every line added will result in  a  line
699              being  removed  from  the top.  If you know you are never
700              going to want all that logged information, this might  be
701              a good setting for you.
702
703               0 = No limit to internal log file size
704
705
706       server_log_recall
707              Number  of  lines  from the bottom of the internal server
708              message log to automatically recall to  your  IRC  client
709              when you reconnect.  If this is low, you may not get much
710              useful information, if this is high, it may take  a  long
711              time for all the information to arrive.
712
713               -1   =   Recall   the  whole  log  (not  recommended  if
714              server_log_always is yes)
715               0 = Don't automatically recall anything
716
717
718       DCC PROXY OPTIONS
719
720       Options affecting proxying and capturing of DCC  chat  and  send
721       requests.
722
723
724       dcc_proxy_incoming
725              Whether dircproxy should proxy DCC chat and send requests
726              sent to you by others on IRC.
727
728               yes = Proxy incoming requests.
729               no = Do not proxy incoming requests.
730
731
732       dcc_proxy_outgoing
733              Whether dircproxy should proxy DCC chat and send requests
734              sent by you to others on IRC.
735
736               yes = Proxy outgoing requests.
737               no = Do not proxy outgoing requests.
738
739
740       dcc_proxy_ports
741              Ports  that  dircproxy  can use to listen for DCC connec‐
742              tions on.  This is for when you're behind a firewall that
743              only allows certain ports through, or when doing DCC-via-
744              ssh.
745
746              It is a comma seperated list of port numbers or ranges of
747              ports, for example '57100-57199,57400,57500,57600-57800'
748
749               any = Use any port given to us by the kernel.
750
751
752       dcc_proxy_timeout
753              Maxmimum  amount  of  time (in seconds) to allow for both
754              sides of a DCC proxy to be connected.
755
756
757       dcc_proxy_sendreject
758              Whether to send a physical REJECT message via  CTCP  back
759              to the source of the request in event of failure.
760
761               yes = Send reject CTCP message back.
762               no = Do not send any message back.
763
764
765       dcc_send_fast
766              Whether  to  ignore the "acknowledgment" packets from the
767              client and just send the file to them as fast  as  possi‐
768              ble.  There should be no real danger in doing this.
769
770               yes = Send as fast as possible.
771               no = Wait for each packet to be acknowledged.
772
773
774       dcc_capture_directory
775              dircproxy  can  capture files sent via DCC and store them
776              on the server.  Especially useful while you are detached,
777              whether  it  does  it  while  attached  or not depends on
778              'dcc_capture_always'.  This is  the  directory  to  store
779              those captured files in.
780
781              If  start  with  "~/"  then it will use a directory under
782              your home directory.
783
784               none = Do not capture files.
785
786
787       dcc_capture_always
788              If we're capturing DCC send's, should we do it while  the
789              client  is  connected as well?  If 'yes', then the client
790              will never see the file, it'll  be  just  stored  on  the
791              server  with  a  notice  sent  to the client telling them
792              where.
793
794               yes = Capture even when a client is connected.
795               no = Capture only when client detached.
796
797
798       dcc_capture_withnick
799              Whether to start the filename of the captured  file  with
800              the nickname of the sender, so you know who it came from.
801
802               yes = Start with nickname.
803               no = Do not alter the filename.
804
805
806       dcc_capture_maxsize
807              Maximum  size (in kilobytes) that a captured file can be.
808              If a captured file is larger than this, or becomes larger
809              than  this, then the capture will be aborted and the file
810              removed from the disk.  Prevents people from filling your
811              disk up while you're detached with a massive file.
812
813               0 = No limit to file size.
814
815
816       dcc_tunnel_incoming
817              Port  of  a local ssh tunnel leading to another dircproxy
818              client that we should  use  for  incoming  DCC  requests.
819              This should not be set if 'dcc_tunnel_outgoing' is set.
820
821              See   the   README.dcc-via-ssh  file  included  with  the
822              dircproxy distribution for more information.
823
824              This can be a numeric port number, or a service name from
825              /etc/services
826
827               none = There is no tunnel.
828
829
830       dcc_tunnel_outgoing
831              Port  of  a local ssh tunnel leading to another dircproxy
832              client that we should  use  for  outgoing  DCC  requests.
833              This should not be set if 'dcc_tunnel_incoming' is set.
834
835              See   the   README.dcc-via-ssh  file  included  with  the
836              dircproxy distribution for more information.
837
838              This can be a numeric port number, or a service name from
839              /etc/services
840
841               none = There is no tunnel.
842
843
844       ADVANCED OPTIONS
845
846       Options for the advanced user.
847
848
849       switch_user
850              If  you're  running dircproxy as root, it can switch to a
851              different "effective user id" to create the  server  con‐
852              nection.   This  means that your system ident daemon (and
853              therefore IRC, if it queries it)  will  see  your  server
854              connection as the user you put here, instead of root.
855
856              This  is  most  useful  if  you  are  sysadmin  running a
857              dircproxy server for multiple people and want them to all
858              appear  as  different  usernames  without  using a hacked
859              identd.  Because dircproxy is still running as  root,  it
860              will  have those privileges for all operations, including
861              the bind(2) for  the  'local_address'  config  option  if
862              you're using Secure Linux patches.
863
864              This  can only be used if your system supports seteuid(2)
865              and if you are running dircproxy as the  root  user,  and
866              not  just  setuid.   Attempting otherwise will generate a
867              warning as dircproxy starts.
868
869              This can be a numeric uid or a username from /etc/passwd.
870
871               none = Do not do this.
872
873
874       MOTD OPTIONS
875
876       Options affecting the dircproxy message of the day.
877
878
879       motd_logo
880              If this is yes, then the dircproxy logo and version  num‐
881              ber  will  be included in the message of the day when you
882              connect.  Only the picky would turn this off, its pretty!
883
884               yes = Show me the pretty logo
885               no = I don't like logos, I'm boring, I eat llamas.
886
887
888       motd_file
889              Custom message of the day file to send when users connect
890              to  dircproxy.   The  contents  of this file will be sent
891              after the logo and before the stats.  If you  start  this
892              with a "~/" then it refers to a file in a directory under
893              your home directory.
894
895               none = No custom motd
896
897
898       motd_stats
899              Display information on what channels you were on, and log
900              file sizes etc in the message of the day.  This is handy,
901              and lets you know  how  not  only  much  information  you
902              missed, but how much will be sent to you.
903
904               yes = Show the stats
905               no = They don't interest me, don't show them.
906
907
908       COMMAND OPTIONS
909
910       Options allowing or disallowing the use of /DIRCPROXY commands.
911
912
913       allow_persist
914              You  can disable the /DIRCPROXY PERSIST command if you do
915              not want people using your proxy to be able to do that.
916
917               yes = Command enabled
918               no = Command disabled
919
920
921       allow_jump
922              You can disable the /DIRCPROXY JUMP command if you do not
923              want people to do that.
924
925               yes = Command enabled
926               no = Command disabled
927
928
929       allow_jump_new
930              If  the /DIRCPROXY JUMP commmand is enabled, then you can
931              disable it being used to jump to a server:port not in the
932              list specified in the configuration file.
933
934               yes = Can jump to any server
935               no = Only ones in the config file
936
937
938       allow_host
939              You can disable the /DIRCPROXY HOST command if you do not
940              want people to do that.
941
942               yes = Command enabled
943               no = Command disabled
944
945
946       allow_die
947              You can enable the /DIRCPROXY DIE  command  if  you  want
948              people  to be able to kill your proxy.  This isn't recom‐
949              mended as a global option, instead only enable it  for  a
950              specific connection class (ie yours).
951
952               yes = Command enabled
953               no = Command disabled
954
955
956       allow_users
957              You  can  enable the /DIRCPROXY USERS command if you want
958              people to be able to see who's using  your  proxy.   This
959              isn't recommended as a global option, instead only enable
960              it for a specific connection class (ie yours).
961
962               yes = Command enabled
963               no = Command disabled
964
965
966       allow_kill
967              You can enable the /DIRCPROXY KILL command  if  you  want
968              people  to  be able to disconnect anyone using your proxy
969              (including you!).  This isn't  recommended  as  a  global
970              option,  instead only enable it for a specific connection
971              class (ie yours).
972
973               yes = Command enabled
974               no = Command disabled
975
976
977       allow_kill
978              You can enable the /DIRCPROXY NOTIFY command if you  want
979              people  to  be able to send a notice to anyone using your
980              proxy (including you!).   This  isn't  recommended  as  a
981              global option, instead only enable it for a specific con‐
982              nection class (ie yours).
983
984               yes = Command enabled
985               no = Command disabled
986
987
988       Additionally, the following keywords may go only inside  a  con‐
989       nection  class  definition.   One  'password'  and  at least one
990       'server'    (unless    'server_autoconnect'    is    'no'    and
991       'allow_jump_new' is 'yes') are mandatory.
992
993
994       password
995              Password  required  to  use  this connection class.  This
996              should be encrypted using your  system's  crypt(3)  func‐
997              tion.   It  must  be the same as the password supplied by
998              the IRC client on connection for this connection class to
999              be used.
1000
1001              You  can  use  the included dircproxy-crypt(1) utility to
1002              generate these passwords.
1003
1004
1005       server Server to connect to.  Multiple servers can be given,  in
1006              which  case  they are iterated when the connection to one
1007              is dropped.  This has the following format:
1008
1009              [hostname[:[port][:password]]
1010
1011
1012       from   The connection hostname must match  this  mask,  multiple
1013              masks  can  be  specified to allow more hosts to connect.
1014              The * and ? wildcards may be used.
1015
1016
1017       join   Channels to join when you first connect.  Multiple  chan‐
1018              nels  can be given, either by seperating the names with a
1019              comma, or by specifying multiple from  the  channel  name
1020              with a space.
1021
1022              Note:  You must surround the list of channels with quotes
1023              to distinguish from comments.
1024
1025              For clarification, this is the format of this line:
1026
1027              join "channel[ key][,channel[ key]]..."
1028
1029

SIGNALS

1031       dircproxy  will  reread  its  configuration  file  whenever   it
1032       receives the hangup signal, SIGHUP.
1033
1034       Sending  an  interrupt  signal,  SIGINT,  or a terminate signal,
1035       SIGTERM, will cause dircproxy to exit cleanly.
1036
1037

NOTES

1039       More information, including announcements of new  releases,  can
1040       be found at:
1041
1042       http://dircproxy.googlecode.com
1043
1044

SEE ALSO

1046       dircproxy-crypt(1) inetd(8) crypt(3)
1047
1048

BUGS

1050       Please submit and review bug reports at:
1051
1052       http://code.google.com/p/dircproxy/issues/list
1053
1054

AUTHOR

1056       Written by Scott James Remnant <scott@netsplit.com>.
1057
1058       Current maintainership by Noel Shrum and Francois Harvey
1059
1060
1062       Copyright  (C)  2000-2003 Scott James Remnant <scott at netsplit
1063       dot com>
1064
1065       Copyright (C) 2004-2008 Francois Harvey <contact at francoishar‐
1066       vey dot ca>
1067
1068       Copyright  (C) 2008-2009 Noel Shrum <noel dot w8tvi at gmail dot
1069       com>
1070
1071                               Francois Harvey <contact at francoishar‐
1072       vey dot ca>
1073
1074       dircproxy is distributed under the GNU General Public License.
1075
1076
1077
1078                                  09 Jan 2009                     dircproxy(1)
Impressum