Changeset 296a6fb


Ignore:
Timestamp:
2018-03-26T03:28:03Z (2 years ago)
Author:
dequis <dx@…>
Branches:
master
Children:
5bb4477
Parents:
2b6cb87
Message:

doc: some improvements to the man page

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/bitlbee.8

    r2b6cb87 r296a6fb  
    4141&bitlbee.
    4242
    43 \fBbitlbee\fP should be called by
    44 .BR inetd (8),
    45 or you can run it as a stand-alone daemon.
     43\fBbitlbee\fP is normally started as a system service (with init
     44scripts, systemd units or equivalent). It can also be run as an
     45.BR inetd (8)
     46/
     47.BR xinetd (8)
     48service or a stand-alone daemon with the options below.
     49
     50To use it, connect to it with an IRC client with a command such as
     51"/connect localhost"
     52
    4653.PP
    47 .SH OPTIONS
     54.SH RUN MODES
    4855.PP
    4956.IP "-I"
    5057Run in
    5158.BR inetd (8)
    52 mode. This is the default setting, you usually don't have to specify this
    53 option.
     59mode. This is the default setting for historical reasons, but not the
     60recommended one (See ForkDaemon below).
    5461.IP "-D"
    55 Run in daemon mode. In this mode, BitlBee forks to the background and
     62Run in \fBDaemon\fP mode. In this mode, BitlBee forks to the background and
    5663waits for new connections. All clients will be served from one process.
     64This mode is also useful for debugging.
    5765.IP "-F"
    58 Run in ForkDaemon mode. This is similar to ordinary daemon mode, but every
     66Run in \fBForkDaemon\fP mode. This is similar to ordinary daemon mode, but every
    5967client gets its own process. Easier to set up than inetd mode, and without
    60 the possible stability issues.
     68the possible stability issues. This is the recommended runmode for most
     69use cases.
     70
     71.PP
     72.SH OPTIONS
     73.PP
     74
    6175.IP "-i \fIaddress\fP"
    62 Only useful when running in daemon mode, to specify the network interface
     76When running in daemon mode, specifies the network interface
    6377(identified by IP address) to which the daemon should attach. Use this if
    6478you don't want BitlBee to listen on every interface (which is the default
    6579behaviour).
    6680.IP "-p \fIport number\fP"
    67 Only useful when running in daemon mode, to specify the port number on
     81When running in daemon mode, specifies the port number on
    6882which BitlBee should listen for connections. 6667 is the default value.
    6983.IP "-n"
    70 Only useful when running in daemon mode. This option prevents BitlBee from
     84Wehn running in daemon mode, this option prevents BitlBee from
    7185forking into the background.
    7286.IP "-v"
     
    8296.SH COMMANDS
    8397To get a complete list of commands, please use the \fBhelp commands\fP
    84 command in the &bitlbee channel.
     98command in the &bitlbee channel after connecting to bitlbee.
    8599.SH "SEE ALSO"
    86 .BR ircd (8),
    87100.BR inetd (8),
    88 .BR inetd.conf (5),
    89 .BR gaim (1).
     101.BR inetd.conf (5)
    90102
    91103.BR http://www.bitlbee.org/
    92104
    93105For more information on using BitlBee, once connected, you should use
    94 the on-line help system.
     106the \fBhelp\fP command in the &bitlbee channel.
    95107.SH BUGS
    96108Of course there are bugs. If you find some, please report them at
Note: See TracChangeset for help on using the changeset viewer.