futurile/guix-play
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Deprecate 'bitlbee-service' procedure.

Browse Source 
* gnu/services/messaging.scm (bitlbee-service): Mark as deprecated.
* doc/guix.texi (Messaging Services): Document 'bitlbee-service-type'
and 'bitlbee-configuration'.  Remove 'bitlbee-service'.
This commit is contained in:
Ludovic Courtès 2018-01-15 22:16:36 +01:00
parent f2bee4210f
commit 37af37dcc9
No known key found for this signature in database
GPG Key ID: 090B11993D9AEBB5
2 changed files with 35 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/guix.texi
View File

@ -14424,23 +14424,45 @@ string, you could instantiate a prosody service like this:
@subsubheading BitlBee Service
@cindex IRC (Internet Relay Chat)
@cindex IRC gateway
@url{http://bitlbee.org,BitlBee} is a gateway that provides an IRC
interface to a variety of messaging protocols such as XMPP.
@deffn {Scheme Procedure} bitlbee-service [#:bitlbee bitlbee] @
[#:interface "127.0.0.1"] [#:port 6667] @
[#:extra-settings ""]
Return a service that runs @url{http://bitlbee.org,BitlBee}, a daemon that
acts as a gateway between IRC and chat networks.
@defvr {Scheme Variable} bitlbee-service-type
This is the service type for the @url{http://bitlbee.org,BitlBee} IRC
gateway daemon. Its value is a @code{bitlbee-configuration} (see
below).
The daemon will listen to the interface corresponding to the IP address
specified in @var{interface}, on @var{port}. @code{127.0.0.1} means that only
local clients can connect, whereas @code{0.0.0.0} means that connections can
come from any networking interface.
To have BitlBee listen on port 6667 on localhost, add this line to your
services:
@example
(service bitlbee-service-type)
@end example
@end defvr
@deftp {Data Type} bitlbee-configuration
This is the configuration for BitlBee, with the following fields:
@table @asis
@item @code{interface} (default: @code{"127.0.0.1"})
@itemx @code{port} (default: @code{6667})
Listen on the network interface corresponding to the IP address
specified in @var{interface}, on @var{port}.
When @var{interface} is @code{127.0.0.1}, only local clients can
connect; when it is @code{0.0.0.0}, connections can come from any
networking interface.
@item @code{package} (default: @code{bitlbee})
The BitlBee package to use.
@item @code{extra-settings} (default: @code{""})
Configuration snippet added as-is to the BitlBee configuration file.
@end table
@end deftp
In addition, @var{extra-settings} specifies a string to append to the
configuration file.
@end deffn
@node Telephony Services
@subsubsection Telephony Services

2
gnu/services/messaging.scm
View File

@ -848,7 +848,7 @@ string, you could instantiate a prosody service like this:
"Run @url{http://bitlbee.org,BitlBee}, a daemon that acts as
a gateway between IRC and chat networks.")))
(define* (bitlbee-service #:key (bitlbee bitlbee)
(define* (bitlbee-service #:key (bitlbee bitlbee) ;deprecated
(interface "127.0.0.1") (port 6667)
(extra-settings ""))
"Return a service that runs @url{http://bitlbee.org,BitlBee}, a daemon that