# rld 1.0 documentation

About Quickstart Reference Arguments Files Console Parameters Known problems | ## Console The rld console can be used to issue commands to a running rld server. It starts up after the server has been initialized. If the file server.rootdir/rld.conf exists, the rld console executes it. Then, depending on the value of admin.console, the admin console either 1) starts reading on stdin, 2) starts listening on a socket, or 3) disables itself altogether. If the parameter admin.password is set, the console prompts users for a password before letting them in. By default, the console listens on stdin and does not require a password. One simple means of getting to your server without sending passwords across the network in cleartext (on machines that you trust) is to bind the admin console to the loopback address 127.0.0.1 and password protect it (see admin.password). If the server machine is running sshd, you can use ssh to create a secure connection between the machine running rld and your own machine. From there you can then telnet to the loopback address and access the admin console. The most secure alternative is to disable the admin console completely. There is no way to reenable a disabled console. While enabled, the console can always be transferred from standard input to a socket and back again. When bound to a socket, the console will only service a single connection at a time (i.e. one way to prevent other people from using the console is by using it yourself), and it times out the connection after a period of inactivity. The console accepts the following commands (commands can be abbreviated to their first few characters): 1. adduser LOGIN [PASS [PRIV [NICK]]] 2. ban SOCK... 3. clients [SOCK...] 4. deluser LOGIN 5. help [CMD] 6. info SOCK... 7. kick SOCK... 8. listusers [LOGIN...] 9. message MSG 10. quit [MSG] 11. set NAME [VALUE] 12. shutdown [MSG] 13. status 14. version 15. xfkill 16. xflist ### 1. adduser LOGIN [PASS [PRIV [NICK]]] Creates a new user account. The only required parameter is LOGIN, to specify a name for the new account. Use the PASS parameter to set a password for the account. If unspecified, defaults to no password required. The PRIVS parameter is a sum describing the privileges for the user, derived from the following table:
            CAN_RENAME_FOLDERS     = 1
            CAN_DELETE_FOLDERS     = 2
            CAN_CREATE_FOLDERS     = 4
            CAN_MOVE_FILES         = 8
            CAN_RENAME_FILES       = 16
            CAN_DOWNLOAD_FILES     = 32
            CAN_UPLOAD_FILES       = 64
            CAN_DELETE_FILES       = 128
            CAN_DELETE_ACCOUNTS    = 256
            CAN_CREATE_ACCOUNTS    = 512
            CAN_SEND_CHAT          = 8192
            CAN_READ_CHAT          = 16384
            CAN_MOVE_FOLDERS       = 32768
            CANNOT_BE_DISCONNECTED = 65536
            CAN_DISCONNECT_USERS   = 131072
            CAN_POST_NEWS          = 262144
            CAN_READ_NEWS          = 524288
            CAN_MODIFY_ACCOUNTS    = 4194304
            CAN_READ_ACCOUNTS      = 8388608
            CAN_MAKE_ALIASES       = 16777216
            CAN_VIEW_DROPBOXES     = 33554432
            CAN_COMMENT_FOLDERS    = 67108864
            CAN_COMMENT_FILES      = 134217728
            DONT_SHOW_AGREEMENT    = 268435456
            CAN_USE_ANY_NAME       = 536870912
            CAN_UPLOAD_ANYWHERE    = 1073741824
            CAN_GET_USER_INFO      = 2147483648
If the PRIVS parameter is left unspecified, it defaults to 0 (an easy way to grant "all privileges" is to specify -1). The NICK parameter specifies a nickname for the user. If not specified, defaults to LOGIN. ### 2. ban SOCK... Disconnects the users with the specified socket ID's and bans them for 30 minutes. ### 3. clients [SOCK...] Prints the list of currently connected users. Optionally the list may be limited to only the specified socket ID's. ### 4. deluser LOGIN Deletes a user account. ### 5. help [CMD] Shows a general help message, or, if CMD is specified, gives more detailed help on that command. The special CMD 'params' gives info on the useful NAME's that can be passed to 'set'. ### 6. info SOCK... Gets info on the users with the specified socket ID's. ### 7. kick SOCK... Disconnects the users with the specified socket ID's. ### 8. listusers [LOGIN...] Lists all user accounts. ### 9. message MSG Broadcasts an administrator message to all connected users. ### 10. quit [MSG] Quits the console. If the console is on standard input, this has the added side effect of shutting down the server; an optional MSG may be supplied to inform connected clients of the reason for shutting down. ### 11. set NAME [VALUE] Unsets NAME when VALUE is omitted, otherwise sets NAME to VALUE. See Parameters for a list of useful NAMEs. ### 12. shutdown [MSG] Terminates the server. If MSG is given, rld will broadcast it as an administrator message before disconnecting all clients. ### 13. status Displays running totals and statistics for the server. ### 14. version Shows the version of rld. ### 15. xfkill Kills a transfer request. XFREF is a unique reference for the transfer. ### 16. xflist Lists all transfers in progress and in the queue. 25 october 2001