WIRE(1)                   BSD General Commands Manual                  WIRE(1)

NAME
     wire -- Wired client

SYNOPSIS
     wire [bookmark]

DESCRIPTION
     wire is a screen-oriented Wired client. It is used to connect to Wired
     servers.

     At startup, wire will read ~/.wire/config and interpret and execute each
     line as a command. Similarly, if a named bookmark is given as an argument
     to wire, ~/.wire/bookmark will also be read and interpreted. Note that
     commands in bookmarks should not be prepended by a `/' character.

     The options are as follows:

     -D      Enables debug mode.  wire will log extra debug messages to the
             chat window.

     -h      Displays a brief help message and exits.

     -v      Displays version information and exits.

WINDOWS
     wire creates new windows in certain situations. To cycle windows, press
     Control-P for previous and Control-N for next. The close command closes
     the current window, or, if in the main window, disconnects from the
     server.

COMMANDS
     The following commands can be given to wire:

     ban user message
        Bans a user. The first argument is the user to ban, the second is the
        message to send.

        Example: /ban morris get lost

        See also: kick

     broadcast message
        Broadcast a message to all users.

        Example: /broadcast restarting server

     cd path
        Changes the working directory.

        Example: /cd /Uploads

     charset charset
        Sets the character set that wire will convert all text from the server
        to. This string is passed directly to the iconv(3) character conver-
        sion system. The default value is `ISO-8859-1'.

        Example: /charset UTF-8

     clear
        Clears all output.

        Example: /clear

     clearnews
        Clear the news.

        Example: /clearnews

     close
        If in main window, disconnects from the current server. Otherwise,
        closes the window.

        Example: /close

     comment path comment
        Sets a file comment. The first argument is the path, the second is the
        comment to set.

        Example: /comment "/Uploads/a file.txt" uploaded by morris

     get path
        Downloads a file. If a transfer is already running, queue the down-
        load. Files are downloaded into the directory from which Wire was
        started.

        Example: /get "/Uploads/a file.txt"

     help [command]
        Shows online help. If an argument is provided, shows online help for
        that command.

        Example: /help, /help get

     icon path
        Loads a custom icon from an image file. It is recommended that the
        image is in PNG format, and does not exceed 32x32 pixels in dimension.
        You will not be able to see the icon in wire, but only in other graph-
        ical clients.

        Example: /icon ~/.wire/icon.png

     ignore [nick]
        Manage user ignores. Without arguments, shows the current list of
        ignores, identified by id. With an argument, adds a user to the list.
        No chat or messages are printed from users whose nicks match an entry
        in the ignore list.

        Example: /ignore, /ignore morris

        See also: unignore

     info user
        Gets user info on the user with the nick name provided.

        Example: /info morris

     invite user
        When in a private chat window, invites the user with the nick provided
        to participate in the chat.

        Example: /invite morris

     kick user message
        Kicks a user. The first argument is the user to kick, the second is
        the message to send.

        Example: /kick morris get lost

        See also: ban

     load bookmark
        Loads a bookmark with the name provided from ~/.wire/.

        Example: /load myserver

     log filename
        Saves a copy of the current output to the file provided.

        Example: /log myserver.log

     ls [path]
        Lists the current directory, or if an argument is provided, the path.

        Example: /ls, /ls Uploads

     me chat
        Sends the argument as action chat.

        Example: /me is away

     mkdir path
        Creates a new directory.

        Example: /mkdir /Uploads

     msg user message
        Sends a private message to the user with the nick name in the first
        argument. The second argument is the message to send.

        wire will create a new window when sending or receiving a private mes-
        sage for every user. Typing text in these windows will send private
        messages to that user.

        Example: /msg morris hey!

     mv from to
        Moves or renames one path to another.

        Example: /mv /Uploads "/Old Uploads"

     news [-number | -ALL]
        Shows the server news. A flag can be passed to set how many news
        entries to show, which is 10 by default. If `ALL' is specified rather
        than a number, the whole news is shown.

        Example: /news, /news -20, /news -ALL

     nick nick
        Sets the current nick name.

        Example: /nick morris

     open host[:port] [-l login] [-p password] [-P port]
        Opens a new connection to a server. The current connection is closed.
        Login and password can be set with the -l and -p flags.

        Example: /open my.server.com, /open my.server.com:3000 -l morris -p
        p4ssw0rd

     ping
        Pings the server to determine latency.

        Example: /ping

     post message
        Posts a new entry to the server news.

        Example: /post check out /Uploads/a file.txt

     put path
        Uploads a file to the current working directory. If a transfer is
        already running, adds the upload to the transfer queue.

        Example: /put ~/a file.txt

     privchat [user]
        Creates a private chat. If a nick is a given, also invites that user
        to participate in the private chat.

        Example: /privchat

     pwd
        Shows the current working directory.

        Example: /pwd

     quit
        Quits wire.

        Example: /quit

     reply message
        Like msg, but sends the message to the user who sent you a message
        last.

        Example: /reply i agree

     rm path
        Deletes the path.

        Example: /rm /Uploads

     save bookmark
        Saves the current settings and connection as a bookmark in ~/.wire/.

        Example: /save myserver

     search query
        Searches the files on the server and displays a list of results.

        Example: /search .jpg

     serverinfo
        Prints information about the current server.

        Example: /serverinfo

     start transfer
        Starts a previously queued transfer by id.

        Example: /start 1

     stat path
        Gets file info on the path.

        Example: /stat /Uploads/a file.txt

     status message
        Sets the current status.

        Example: /status away

     stop transfer
        Stops a running transfer by id.

        Example: /stop 1

     timestamp [format]
        Without arguments, disables the timestamps. With an argument, sets the
        timestamp format, a la strftime(3).  Default is `%H:%M'.

        Example: /timestamp %H:%M:%S

     topic [message]
        Without arguments, prints the current chat topic. With an argument,
        sets a new topic.

        Example: /topic, /topic welcome to my.server.com

     type path type
        Sets the folder type. The first argument is the path, the second is
        one of `folder', `uploads' and `dropbox', indicating the folder type.

        Example: /type /Uploads uploads

     unignore [ignore]
        Removes an ignored user by id.

        Example: /uignore 1

        See also: ignore

     uptime
        Shows current uptime statistics.

        Example: /uptime

     version
        Shows version information.

        Example: /version

     who
        Shows the user list.

        Example: /who

FILES
     ~/.wire/config
          Default configuration file. Read at startup. Consists of a newline
          separated list of commands.

     ~/.wire/bookmark
          A named bookmark. Read at startup if bookmark is specified. Read at
          runtime using the load command. Consists of a newline separated list
          of commands.

AUTHORS
     wire and the Wired protocol were developed by Axel Andersson, Zanka Soft-
     ware.

BSD                              Jan 22, 2006                              BSD