iroffer v1.3 documentation - administration commands

What are admin commands

You control and administrate iroffer through text administrative commands as described below.

Ways of issuing admin commands

Administration commands can be issued in one of these three ways:

In foreground mode, you can issue the command by just typing it through your shell

From irc, you can /msg iroffer commands. Use "/msg bot admin pass command args..." where bot is the bot's nick, pass is your password, and command is the command.

From irc, you can open a dcc chat with iroffer and log in and issue commands through the chat. You can also have iroffer chat you by issueing a "chatme" command via /msg bot admin pass chatme.


command: help	available: console, dcc, msg
description: Shows short description for admin commands
example: help
output: -- Info Commands -- HELP - Shows Help XDL - Lists Offered Files XDS - Save XDCC File DCL - Lists Current Transfers DCLD - Lists Current Transfers with Details TRINFO n - Lists Information About Transfer n QUL - Lists Current Queue IGNL - Show Ignored List LISTUL - Shows contents of upload directory CHANL - Shows channel list with member list -- Transfer Commands -- CLOSE n - Cancels Transfer with ID = n CLOSEU n - Cancels Upload with ID = n RMQ n - Removes Queue Number n NOMIN n - Disables Minspeed For Transfer ID n NOMAX n - Disables Maxspeed For Transfer ID n SEND nick n - Sends Pack n to nick PSEND <channel> <style> - Sends <style> (full\|minimal\|summary) XDCC LIST to <channel> QSEND - Sends Out The First Queued Pack -- Pack Commands -- INFO n - Show Info for Pack n REMOVE n - Removes Pack n REMOVEDIR <dir> - Remove Every File in <dir> RENUMBER x y - Moves Pack x to y ADD <filename> - Add New Pack With <filename> ADDDIR <dir> - Add Every File in <dir> CHFILE n <msg> - Change File of pack n to <msg> CHDESC n <msg> - Change Description of pack n to <msg> CHNOTE n <msg> - Change Note of pack n to <msg> CHMINS n x - Change min speed of pack n to x KB CHMAXS n x - Change max speed of pack n to x KB CHGETS n x - Change the get count of a pack -- Misc Commands -- MSG <nick> <message> - Send a message to a user MESG <message> - Sends msg to all users who are transferring MESQ <message> - Sends msg to all users in a queue IGNORE n <hostmask> - Ignore hostmask (nick!user@host) for n minutes, wildcards allowed UNIGNORE <hostmask> - Un-Ignore hostmask NOSAVE n - Disables XDCC AutoSave for next n minutes NOSEND n - Disables XDCC Send for next n minutes NOLIST n - Disables XDCC List and Plist for next n mins MSGREAD - Show MSG log MSGDEL - Delete MSG log RMUL <file> - Delete a file in the Upload Dir RAW <command> - Send <command> to server (RAW IRC) -- Bot Commands -- SERVERS - Shows the server list JUMP <num> - Switches to a random server or server <num> SERVQC - Clears the server send queue STATUS - Show Useful Information REHASH - Re-reads config file(s) and reconfigures BOTINFO - Show Information about the bot status MEMSTAT - Show Information about memory usage CLEARRECORDS - Clears transfer, bandwidth, uptime, and total sent REDRAW - Redraws the Screen DELHIST - Deletes console history QUIT - Close this DCC chat CHATME - Sends you a DCC Chat Request CHATL - Lists DCC Chat Information CLOSEC n - Closes DCC Chat with ID = n DEBUG n - Set Debugging level to n SHUTDOWN <act> - Shutdown iroffer, <act> is "now", "delayed", or "cancel"

command: xdl	available: console, dcc, msg
description: Shows a list of packs that are offered. Shown in full format.
output: 2 packs 12 of 12 slots open, Record: 65.8KB/s Bandwidth Usage Current: 0.5KB/s, Cap: 50.0KB/s, Record: 2.5KB/s To request a file type: "/msg offerDCC xdcc send #x" To request details type: "/msg offerDCC xdcc info #x" #1 4618x [ 55K] iroffer 1.0.1 - Stable (v1.0) version #2 361x [ 66K] iroffer 1.1b8 - Experimental (v1.1) version The official iroffer distribution source

command: xds	available: console, dcc, msg
description: Writes out the state and xdcc list files immediately.

command: dcl	available: console, dcc, msg
description: Shows a summary of the current transfers.
output: Current Transfers ID User File Status 5 PMG1 testfile1.tgz Listening 10 PMG2 testfile2.tgz Sending 47% 11 PMG3 testfile3.tgz Sending 90% 15 PMG4 testfile4.tgz Finishing Current Upload ID User File Status 1 PMG5 testfile5.tgz Getting 33%
notes: ID: Each transfer and upload has an ID assigned to it User: The Nick of the person who requested the transfer at the time it was requested File: The filename of the transfer Status: Listening: The transfer has been offered, but the requestor hasn't connected yet Sending: Transfering the file, shows the percentage done Finishing: The transfer has been sent, waiting for acknoledgement Closing: The transfer is complete, but hasn't been removed from the list yet Connecting: The upload has been offered, but hasn't connected yet Getting: The upload is transfering

command: dcld	available: console, dcc, msg
description: Shows a detailed list of the current transfers
output: Current Transfers ID User File Status ^- Speed Current/ End Start/Remain Min/ Max Resumed -------------------------------------------------------------------- 5 PMG testfile1.tgz Sending 40% ^- 2.9K/s 16399K/ 40686K 1h06m/ 2h21m no/ no 5458K 11 PMG2 testfile3.tgz Sending 24% ^- 3.0K/s 8650K/ 36178K 38m08s/ 2h35m no/ no no -------------------------------------------------------------------- Current Uploads ID User File Status ^- Speed Current/ End Start/Remain -------------------------------------------------------------------- 1 testDCC testfile20 Getting 31% ^- 0.0K/s 6371K/ 20480K 0m00s/99h59m --------------------------------------------------------------------
notes: ID: Each transfer and upload has an ID assigned to it User: The Nick of the person who requested the transfer at the time it was requested File: The filename of the transfer Status: Listening: The transfer has been offered, but the requestor hasn't connected yet Sending: Transfering the file, shows the percentage done Finishing: The file has been sent, waiting for acknoledgement Closing: The transfer is complete, but hasn't been removed from the list yet Connecting: The upload has been offered, but hasn't connected yet Getting: The upload is transfering Speed: The current transfer speed. Current: The current position in the file End: The end (size) of the file Start: How long ago the transfer started Remain: Estimated time until transfer is finished Min: Minimum speed of this transfer (if it has a min) Max: Maximum speed of this transfer (if it has a max) Resumed: Where the file was resumed from (if resumed)

command: trinfo <id>	available: console, dcc, msg
description: Shows super detailed information about a single transfer
example: trinfo 0
output: Transfer Info for ID 1: User PMG, Hostname cant.get.enough.iroffer.org, Status Sending File: testfile1.tgz Start 5458K, Current 18624K, End 40686K (46% File, 37% Xfer) Min no, Current 3.1K/s, Max no, In Transit 116K Transfer started 1h 19m ago, Finish in 1h 58m, Last contact 0m 0s ago. Local: 10.0.0.1:3091, Remote: 10.0.0.2:1114 Sockets: Listen 0, Transfer 7, File 6
notes: User: The Nick of the person who requested the transfer at the time it was requested Hostname: The hostname of the person who requested the transfer at the time it was requested Status: Listening: The transfer has been offered, but the requestor hasn't connected yet Sending: Transfering the file, shows the percentage done Finishing: The file has been sent, waiting for acknoledgement Closing: The transfer is complete, but hasn't been removed from the list yet File: The filename of the transfer Start: Where in the file the transfer was started from Current: The current position in the file End: The end (size) of the file % File: How far into the file the transfer is % XFer: How far into the transfer the transfer is Min: Minimum speed of this transfer (if it has a min) Current: The current running transfer speed. Max: Maximum speed of this transfer (if it has a max) In Transit: The amount of data sitting in the socket buffer plus in transit to the user. Transfer Started: How long ago the transfer started Finish in: Estimated time until transfer is finished Last contact: How long ago the last contact from the user was Sockets: The socket numbers associated with this transfer, 0 if that socket isn't in use

command: qul	available: console, dcc, msg
description: Shows a summary of the current queued people.
output: Current Queue: # User File Waiting Left 1 PMG testfile1 2h23m 1h15m
notes: #: The Queue Position. User: The Nick of the person who requested the transfer at the time it was requested File: The filename of the queue entry. Waiting: How long the user has been waiting in the queue. Left: Estimated time remaining until transfer starts.

command: ignl	available: console, dcc, msg
description: Shows a list of the currently ignored people (Ingore List) as well as people who might become ignored (Watch List).
output: Current Ignore List: Last Request Un-Ignore Type Hostmask 0m02s ago 1m40s auto PMG1!pmg@cant.get.enough.iroffer.org 0m02s ago 10m00s manual PMG2!pmg@another.host.at.iroffer.org Current Watch List: Last Request Un-Watch Hostmask 0m02s ago 1m40s PMG3!pmg@some.other.host.at.iroffer.org
notes: Last Request: how long ago the last contact with this host was, or when the ignore was activated whichever is less. Un-Ignore: how long from now until the ignore expires Type: shows if the ignore entry was a auto-ignore due to excessive requests or if the host was manually ignored due to an ignore command Hostmask: the user that is being ignored

command: listul	available: console, dcc, msg
description: Shows a list of all files in the upload directory as well as their file sizes. Device size and available space are also shown.
output: Listing './upload': =DIR= a_directory 20M testfile20 20M testfile20a Device size: 684G, used 134G, free 550G, reserved 100M

command: chanl	available: console, dcc, msg
description: Lists all channels and who is on each of them.
output: Channel Members: #test01: PMG1 PMG2 PMG3 PMG4 PMG5

command: close <id>	available: console, dcc, msg
description: Closes the transfer for the given transfer ID, use "dcl" or "dcld" to find the transfer id.
example: close 1

command: closeu	available: console, dcc, msg
description: Closes the upload for the given upload ID, use "dcl" or "dcld" to find the upload id.
example:close 1

command: rmq <id>	available: console, dcc, msg
description: Removed an entry in the queue. Use "qul" to find the queue id.
example: for queue "10" use "rmq 10"

command: nomin <id>	available: console, dcc, msg
description: Disables the minspeed requirement for an in-process transfer. Use "dcl" or "dcld" to find the transfer id.
example: nomin 1

command: nomax <id>	available: console, dcc, msg
description: Disables the maxspeed limit for an in-process transfer. Use "dcl" or "dcld" to find the transfer id. The transfer will still be limited by an overall max speed limit though (if configured).
example: nomax 1

command: send <nick> <pack_num>	available: console, dcc, msg
description: Manually sends the pack "pack_num" to "nick". This will avoid the queue if necessary.
example: send PMG 1

command: psend <channel>	available: console, dcc, msg
description: Manually sends a xdcc list to a channel. NOTE: if iroffer isn't on the channel, the channel must be mode -n.
example: psend #somechannel

command: qsend	available: console, dcc, msg
description: Sends out the first queued pack even if there is no transfer slot available.

command: info <pack_num>	available: console, dcc, msg
description: Shows detailed information for an offered pack.
example: info 1
output: Pack Info for Pack #1: Filename /home/pmg/testfile20 Sendname testfile20 Description testfile20 Note this is a note Filesize 20971520 [ 20MB] Last Modified 1999-01-20-23:13:46 Device/Inode 11/13778947 Gets 7 Minspeed 10.0KB/sec Maxspeed 100.0KB/sec md5sum 21530698ff52165d721977af137b2a3f
notes: Filename: The full filename for the offered pack Sendname: The filename as it will be offered as. Description: The description for the pack Note: The note for the pack Filesize: The size (size in bytes, and short string) Last Modified: File's last modification date Device/Inode: File's device and inode numbers Gets: The number of times this pack has been completed Minspeed: The minspeed for the pack Maxspeed: The maxspeed for the pack md5sum: md5sum of the file if known

command: remove <pack_num>	available: console, dcc, msg
description: Removed a single pack from the list of offered files. All packs numbered after this one will decrement to fill the gap.
example: remove 1

command: removedir <directory>	available: console, dcc, msg
description: Removed every file in a directory. This command basically makes a sub-call to "remove" for each file in that directory.
example: remove 1

command: renumber <old_pack_num> <new_pack_num>	available: console, dcc, msg
description: Moves pack number "old_pack_num" to number "new_pack_num". All other packs are shifted to fill and make gaps as needed.
example: renumber 2 3

command: add <file_path>	available: console, dcc, msg
description: Adds a file as a pack. You can specify a complete path, a relative path (relative from where iroffer was started) or just a filename in the current directory. iroffer will first try the path/file you sepecify, and if that is unsucessful, it will append it to the "filedir" in your config file and try again. The pack will be given a new pack number. You should then change the description with a "chdesc" command.
example: add /home/pmg/file.tgz

command: adddir <dir_path>	available: console, dcc, msg
description: Adds every file in a directory. This command basically makes a sub-call to "add" for each file in that directory.
example: adddir /home/pmg/files/

command: chfile <pack_num> <file_path>	available: console, dcc, msg
description: Changes the file associated with a given pack. You can specify a complete path, a relative path (relative from where iroffer was started) or just a filename in the current directory. iroffer will first try the path/file you sepecify, and if that is unsucessful, it will append it to the "filedir" in your config file and try again.
example: chfile 1 /home/pmg/file.tgz

command: chdesc <pack_num> <description>	available: console, dcc, msg
description: Changes the description associated with a given pack. Can be multiple words, no need for "'s
example: chdesc 1 Some Nice Test File

command: chnote <pack_num> <note>	available: console, dcc, msg
description: Changes the note associated with a given pack. Can be multiple words, no need for "'s You should avoid using notes in favor of longer descriptions (see "chdesc") whenever possible. Notes add more lines of text to a xdcc list which slow down sending lists to users and channels.
example: chnote 1 Blah, Blah, Blah

command: chmins <pack_num> <speed_in_K>	available: console, dcc, msg
description: Changes the minimum speed limit for a pack. If you specify the same min speed as the overall min speed, this transfer will go back to the overall setting. If you specify 0, the pack will have no minspeed (even if there is an overall min speed set).
example: chmins 1 2.5

command: chmaxs <pack_num> <speed_in_K>	available: console, dcc, msg
description: Changes the maximum speed limit for a pack. If you specify the same max speed as the overall per-pack max speed, this transfer will go back to the overall setting. If you specify 0, the pack will have no maxspeed (even if there is an overall per-pack max speed set).
example: chmaxs 1 20

command: chgets <pack_num> <speed_in_K>	available: console, dcc, msg
description: Changes the get count for a pack if you want to cheat.
example: chgets 1 200

command: msg <nick> <message>	available: console, dcc, msg
description: Sends a /msg to specific user who. Can be multiple words, no need for "'s
example: msg PMG Hi there

command: mesg <message>	available: console, dcc, msg
description: Sends a /msg to every user who is transfering. Can be multiple words, no need for "'s
example: mesg Sorry, I need to shutdown in 10 minutes

command: mesq <message>	available: console, dcc, msg
description: Sends a /msg to every user who is waiting in a queue. Can be multiple words, no need for "'s
example: mesq Sorry, please forgive the delay, I can't send to everyone at once

command: ignore <minutes> <hostmask>	available: console, dcc, msg
description: Installs a manual ignore for a specific hostmask for a certain amount of time. NOTE: you should specify a hostmask not a hostname. Wild cards are accepted. To ignore indefinately, just use a large number.
example: ignore 60 PMG!pmg@.iroffer.org

command: unignore <hostmask>	available: console, dcc, msg
description: Removes an ignore for a specific hostmask.
example: unignore PMG!pmg@.iroffer.org

command: nosave <minutes>	available: console, dcc, msg
description: Disables autosaving the XDCC file and state file for a specific amount of time. If you want to cancel a nosave, just do a "nosave 0"
example: nosave 60

command: nosend <minutes>	available: console, dcc, msg
description: Disables requests for transfers for a specific amount of time. If you want to cancel a nosend, just do a "nosend 0"
example: nosend 60

command: nolist <minutes>	available: console, dcc, msg
description: Disables sending of Plists and XDCC lists for a specific amount of time. If you want to cancel a nolist, just do a "nolist 0"
example: nolist 60

command: msgread	available: console, dcc, msg
description: Shows the contents of the msg log
output: 2000-02-11-19:56:37: pmg!pmg@cant.get.enough.iroffer.org ^- hummm.. whats going on? msglog: 1 message in log, use MSGDEL to remove it
notes: The date and time, hostmask and message are shown for all messages in the log

command: msgdel	available: console, dcc, msg
description: Deletes the entire msg log

command: rmul <filename>	available: console, dcc, msg
description: Deletes the specified file in the Upload Directory.

command: raw <command>	available: console, dcc, msg
description: Sends text directly to the irc server. This is an advanced feature that most people will not need. Please do not use this as a way of joining channels. Modify your config file and rehash. Refer to RFC 1459 for the format of the IRC protocol. Can be multiple words, no need for "'s
example: raw MODE #channel +o PMG

command: servers	available: console, dcc, msg
description: Shows the server list (names and numbers) as well as the current server and it's real name.
output: Server List: Num Server/Port 1 irc1.iroffer.net 6667 2 irc2.iroffer.net 6667 3 irc3.iroffer.net 6667 4 irc4.iroffer.net 6667 Current Server: irc1.iroffer.net:6667 (irc1.iroffer.net)

command: jump	available: console, dcc, msg
description: Switches to the next randomly choosen server. This is the same as sending iroffer the "SIGUSR1" signal with kill.

command: servqc	available: console, dcc, msg
description: Clears the server send queue. This can be used if it gets very large due to flooding.

command: status	available: console, dcc, msg
description: Shows a summary of the bot transfer status, this is also sent to the log file and dcc chat if "logstats" is enabled in your config file
output: Stat: 0/6 Sls, 0/10 Q, 322.0K/s Rcd, 0 SrQ (Bdw: 0K, 0.0K/s, 482.0K/s Rcd) A B C D G H I J K "/ctcp bot status" has a more compact format and includes more info: stat 10 691 7856 473170 0 6 0 10 0 0 322.0 16 0 0.0 482.0 W X Y Z A B C D - - G H I J K
notes: A = number of slots in use B = total slots C = number in main queue D = size of main queue G = pack speed record (K/sec) H = number of lines in send to server queue I = amount of data sent to network in past 120 seconds (K) J = average bandwidth of past 120 seconds (K/sec) K = record average bandwidth (K/sec) W = number of packs offered X = total size of offered packs (MB) Y = total completed transfers Z = total transfered (MB)

command: rehash	available: console, dcc, msg
description: Causes iroffer to re-read its config file(s) and reconfigure itself with any changes made to the file(s). If you get any warnings, fix the problem and re-rehash as soon as possible.

command: botinfo	available: console, dcc, msg
description: Shows information about the bot's operations and status
output: BotInfo: iroffer 1.3.b09 [20040823145936], http://iroffer.org/ - Linux 2.4.25 iroffer started up 0 Days 0 Hrs and 40 Min ago total running time of 3 Days 7 Hrs and 12 Min cpu usage: 0.09s user (0.00367%), 0.63s system (0.02566%) configured nick: testDCC, actual nick: testDCC, realname: NAME, modes: +i current server: irc.iroffer.net 6667 (direct) current server actual name: irc.iroffer.net channel #channel1: joined: yes channel #channel2: joined: no , plist every 12 min (full) channel #channel3: joined: yes, plist every 12 min (full) bandwidth: lowsend: 45, minspeed: 0.0, maxspeed: 0.0, overallmaxspeed: 100 default max: 100, day max: 50 ( 6:00 -> 20:59, days="MTWRF" ) files: pid: test.pid, log: test.log, state: test.state, xdcclist test.txt config file: test.config upload allowed, dir: ./upload, max size: 50MB console buffering: 70771 written, 69959 flushed, 0 dropped (812 queued) transfer method: linux-sendfile (blocksize 4380)
notes: iroffer's version, and OS How long ago iroffer started running The total amount of time that iroffer has been running with this xdcc file cpu usage: the total amount of CPU time that iroffer has used since it was started up and the percentage of the system CPU time. User is the amount of time used running code inside iroffer, system is the amount of time used making system calls and doing I/O. nick: The nick iroffer is using (both configured and actual) realname: The realname iroffer is using modes: The user modes iroffer is using current server: The curent server, port, and connection method current server actual name: What the curent server reports ifself as channel: A list of channels, wheather or not iroffer has joined them, and their plist status. lowsend: the low send amount minspeed: the overall transfer min speed maxspeed: the overall transfer max speed overallmaxspeed: the curent overall bot-wide max speed default max: the default overall bot-wide max speed day max: the day overall bot-wide max speed and the days and times in which that speed is used pid: the pid filename log: the log filename state: the state filename xdcclist: the xdcc list filename config files: the list of config file filename(s) upload: upload status, the upload directory, and the max size of uploads console buffering: stats about console buffering transfer method: the method and blocksize iroffer is using to transfer files (linux-sendfile, freebsd-sendfile, mmap/write, or read/write)

command: memstat <list>	available: console, dcc, msg
description: Shows detailed information about iroffer's memory usage. This is an advanced feature that most people will not need.
example: memstat
output: iroffer memory usage: rusage: maxrss 0, ixrss 0, idrss 0, isrss 0, minflt 32, majflt 229, nswap 0 inbloc 0, oublock 0, msgsnd 0, msgrcv 0, nsignals 0, nvcsw 0, nivcsw 0 gdata: 7820 bytes heap: 15414 bytes, 87 allocations (7 created in past 10 min) (depth 1) mmaps: 0 kbytes, 0 file mappings iroffer heap details: id \| address \| size \| when \| where 0 0 \| 0x08080F00 \| 6144B \| 0s \| src/iroffer_utilities.c:988 meminfo_grow() 3 0 \| 0x0809D870 \| 20B \| 1295s \| src/iroffer_display.c:422 parseconsole() 5 0 \| 0x08087FD0 \| 1B \| 0s \| src/iroffer_statefile.c:1150 read_statefile() 7 0 \| 0x080AAF00 \| 21B \| 853s \| src/iroffer_misc.c:154 getconfig_set()
notes: rusage: the members of a rusage() call gdata: size of the global data structure heap: heap information mmaps: list of mmaps in use for transfers iroffer heap details: list of the heap allocations

command: clearrecords	available: console, dcc, msg
description: Clears the transfer, bandwidth, uptime, and total sent records.

command: redraw	available: console
description: Redraws the console in foreground mode

command: delhist	available: console
description: Deletes the command history on the console session.

command: quit	available: dcc
description: Closes the current DCC chat session

command: chatme	available: msg
description: Instead of you chatting iroffer, you can get iroffer to chat you by /msg'ing it a chatme command. This is useful if you are behind a firewall and can't accept tcp connections.

command: chatl	available: console, dcc, msg
description: Lists all dcc chat sesssions and dcc chat attempts.
output: DCC CHAT 1: Chat established with PMG. Connected at 2004-08-31-14:01:46 Last contact 2004-08-31-14:01:46 Local: 10.0.0.1:33358, Remote: 10.0.0.2:14425
notes: Chat status (one of): Chat sent to nick. Waiting for inbound connection. Chat received from nick. Waiting for outbound connection. Chat established with nick. Waiting for password. Chat established with nick. Connected at: connection time Last contact: last contact Local: local ip and port Remote: remote ip and port

command: closec	available: console, dcc, msg
description: Closes the dcc chat session for the given chat ID, use "chatl" to find the chat id.
example:closec 1

command: debug <level>	available: console
description: Sets the debugging level for the console. 0 disables all debugging messages, 1 or higher shows debugging information (the larger the number the more info). Output is only displayed to the console not log file and not DCC chat sessions.
example: debug 1

command: shutdown <command>	available: console, dcc, msg
description: Shuts down iroffer, or activate or cancel a delayed shutdown. Command is either "now", "delayed" or "cancel". Issuing a delayed shutdown will schedule iroffer to shutdown once there are no active transfers. People may still continue to request transfers, but iroffer will only shutdown when it is completely idle. If you wish to let the curent transfers finish but not allow people to start new ones you can also issue a "nosend" command.
example: shutdown now

Page last modified: %G%