/wired/head.gif
WIRED(8)                  BSD System Manager's Manual                 WIRED(8)

NAME
     wired -- Wired server

SYNOPSIS
     wired [-46Dlhtuv] [-d server_root] [-f config_file] [-i log_lines]
           [-L log_file] [-s syslog_facility]

DESCRIPTION
     wired is the Wired server program, implementing the Wired chat and file
     transfer protocol. It is designed to run as a standalone server. On
     startup, wired will read the specified configuration file, bind to the
     specified ports and listen for connections. It is recommended that
     wiredctl(1) is used to control the starting and stopping of wired.

     The options are as follows:

     -4      Listen on IPv4 addresses only.

     -6      Listen on IPv6 addresses only.

     -D      Do not daemonize.  wired will run in the foreground and log to
             stderr.

     -d server_root
             Sets the server root path.  wired will attempt to locate its
             required files under this directory. The default value is set to
             the path wired was originally installed as, so it will most often
             not need to be set.

     -f config_file
             Sets the path of the configuration file, relative to server_root.
             The default is etc/wired.conf.

     -h      Displays a brief help message and exits.

     -i log_lines
             When logging to a file using -L, limit the number of lines the
             log may occupy to log_lines.

     -L log_file
             Sets the path of the file that wired will log to. If it is not
             set, wired will instead log via syslog(3).

     -l      Increases the log level. By default, wired will log everything
             but debug messages. Use this flag once to also log debug mes-
             sages.

     -s syslog_facility
             Sets the syslog(3) facility to use for logging. See for informa-
             tion on possible values. The default is daemon.

     -t      Runs a configuration syntax test and exit.

     -v      Displays version information and exits.

CONFIGURATION FILE
     wired reads configuration data from config_file.  The file format and
     configuration options are described in wired.conf(5).

FILES
     The locations of these files can be configured in config_file, this list
     describes the default locations. All files are contained within the
     server_root path.

     banlist
             A newline separated list of permanently banned IPs. Subnet nota-
             tion (192.168.0.0/16 or 192.168.0.0/255.255.0.0) and wildcards
             (192.168.*.*) are recognized.

     etc/certificate.pem
             An OpenSSL certificate as described in req(1).

     etc/wired.conf
             A configuration file for wired.  Its file format is described in
             wired.conf(5).

     files/  A directory containing all files that are publically available to
             connected users.

     groups  A newline separated list of group accounts. Each line consists of
             the following fields, separated by `:':

                   name
                   can get user info
                   can broadcast
                   can post news
                   can clear news
                   can download
                   can upload
                   can upload anywhere
                   can create folders
                   can move files
                   can delete files
                   can view drop boxes
                   can create accounts
                   can edit accounts
                   can delete accounts
                   can elevate privileges
                   can kick users
                   can ban users
                   cannot be kicked
                   download speed limit
                   upload speed limit
                   download limit
                   upload limit
                   can set chat topic
                   files root directory

     news    A public news file for the server. This file is a series of the
             following fields, separated by an ASCII file separator character:

                   name
                   timestamp
                   content

             Each such record of fields is separated by an ASCII group separa-
             tor character.

     wired.status
             A status file for the daemon. It is written to periodically, and
             is used by wiredctl(8) and others to display some statistics. The
             file is a series of numbers, separated by a space character:

                   time of startup
                   number of online users
                   total number of users
                   number of active downloads
                   total number of downloads
                   number of active uploads
                   total number of uploads
                   number of bytes downloaded
                   number of bytes uploaded

     users   A newline separated list of user accounts. Each line consists of
             the following fields, separated by `:':

                   name
                   password
                   group
                   can get user info
                   can broadcast
                   can post news
                   can clear news
                   can download
                   can upload
                   can upload anywhere
                   can create folders
                   can move files
                   can delete files
                   can view drop boxes
                   can create accounts
                   can edit accounts
                   can delete accounts
                   can elevate privileges
                   can kick users
                   can ban users
                   cannot be kicked
                   download speed limit
                   upload speed limit
                   download limit
                   upload limit
                   can set chat topic
                   files root directory

AUTHORS
     wired and the Wired protocol were developed by Axel Andersson, Zanka
     Software.

SEE ALSO
     wiredctl(1), wired.conf(5)

BSD                               Feb 5, 2007                              BSD

Zanka Software | Contact