home *** CD-ROM | disk | FTP | other *** search
/ Enigma Amiga Life 113 / EnigmaAmiga113CD.iso / software / on-line / bwap / readme < prev   
Encoding:
Text File  |  2000-06-14  |  6.6 KB  |  267 lines
  1.  
  2.  
  3. Environment Variables.
  4.  
  5. Each of these can be exported before running BXnap.
  6.     NAPNICK your default nick
  7.     NAPPASS your default pass
  8.     NAPSERVER a server list
  9.     NAPPORT the metaserver port to use.
  10.  
  11. the serverlist is in the following format.
  12.  
  13.     servername:port:nick:password:usemeta
  14.  
  15.     opennap.fortyoz.org::blah:hrm:1
  16.  
  17.     opennap.fortyoz.org:8888:blah:hrm
  18.  
  19. Upon startup a ~/.bwaprc is search for and loaded. Within that file you can
  20. have various commands..
  21.     ex.
  22.     server +add server.name:port:nick:password:meta
  23.  
  24.  
  25. BWap [flags] [server] [nickname]
  26.  
  27.     -N        do not autoconnect to a server
  28.     -r filename    load filename list of server.
  29.     -a        add servers, to not overwrite.
  30.     -n        nickname to use
  31.     -p        password to use [not advisable to use this]
  32.     -C        create user account.
  33.  
  34.  
  35. I'd like to thank all those that have contributed time and code to the BWap
  36. project. Some of this code is taken from BitchX/epic irc clients.
  37.  
  38. ~~~~~~~~~~~~~ Various Commands ~~~~~~~~~~~~~~~~
  39.  
  40. ADMIN <command> [args]
  41.     Various adminstration commands.
  42.  
  43. BIND <key> <command>
  44.     bind your keys to something else
  45.  
  46. BROWSE <nick>
  47.     browse nick for files
  48.  
  49. CLEAR [-all|-unhold|-scrollback]
  50.     clear a window
  51.  
  52. CLOSE [servernum]
  53.     close current server. Or specified server.
  54.  
  55. DELETE <#|*|range>
  56.     Delete transfer with #. * will delete all transfers. A range can be
  57.     specified. 
  58.  
  59. DF
  60.     Display disk usage
  61.  
  62. DISCONNECT
  63.     see close.
  64.  
  65. EVAL
  66.     evaluate a function. This is incomplete.
  67.  
  68. EXEC [-OUT|-NAME arg|-WINDOW|-MSG nick|-LINE {commands}|-LINEPART {command}|
  69.     -ERRORPART {command}|-END {command}|-CLOSE index|-START|-IN text|
  70.     -DIRECT|-num %process| <command>]
  71.  
  72. GET [[-browse|-request] args]
  73.     Will attempt to get a file after a /search or /browse is performed.
  74.     Args can be a range of numbers to get.
  75.  
  76. GLIST
  77.     Display your download/uploads
  78.  
  79. HISTORY [-clear|#]
  80.     Your command history buffer.
  81.  
  82. HOTLIST [nick|-nick]
  83.     With no args, display the hotlist.
  84.     nick will be added to your hotlist.
  85.     -nick will remove from your hotlist.
  86.  
  87. IGNORE [nick|-nick]
  88.     Display the ignore list or add nick to your ignore list or -nick is
  89.     removed.    
  90.  
  91. JOIN <channel>
  92.     Join to a napster channel.
  93.  
  94. L [channel]
  95.     Will part from a channel. If no channel is specified your current
  96.     channel is parted.
  97.  
  98. LASTLOG [-MAX|-LITERAL text|-REVERSE|-TIME|-BEEP|-CLEAR|-APPEND|-FILE name|
  99.     -MORE|-<LEVEL> pattern]
  100.     Displays the lastlog buffer.
  101.  
  102. LEAVE [channel]
  103.     Will part from a channel. If no channel is specified your current
  104.     channel is parted.
  105.  
  106. LIST
  107.     Will display all channels available to join.
  108.  
  109. LOAD <script>
  110.     Load's a script. This is almost like a irc script.
  111.  
  112. LS [options] [pattern/dir]
  113.     alias for the ls command.
  114.  
  115. M <nick> <text>
  116.     Sends a msg to nick. Multiple nicks can be specified as well as
  117.     channels using ,'s to separate them.
  118.  
  119. ME <args>
  120.     send's a me to the current channel.
  121.  
  122. MOTD
  123.     displays the MOTD of the server. This depends on the value of /set
  124.     SUPPRESS_SERVER_MOTD
  125.  
  126. MSG <nick> <text>
  127.     Sends a msg to nick. Multiple nicks can be specified as well as
  128.     channels using ,'s to separate them.
  129.  
  130. NAMES <channel>
  131.     Requests the server to send a list of channel nicks.
  132.  
  133. ON
  134.     This is a scripting command from BitchX irc client. More
  135.     documentation to be written.
  136.  
  137. PARSEKEY 
  138.     Used for changing keybinds.
  139.  
  140. PART [channel]
  141.     Alias for /LEAVE and /L
  142.  
  143. PING <nick>
  144.     Attempts to ping a nick on napster. indication of server lag.
  145.  
  146. PRINT [-BITRATE #|-COUNT #|-FREQ #|-MD5|-FORMAT string| pattern]
  147.     Will print out your shared file list. /set FILENAME_FORMAT and /set
  148.     DIRECTORY_FORMAT determine the output if set.
  149.  
  150. PS
  151.     process list.
  152.  
  153. QUERY [nick|nick1,nick2]
  154.     query's a nick or group of nicks. 
  155.  
  156. QUEUE [-remove "pattern"|-clear]
  157.     display the download/upload queue. option allow removal of a
  158.     nick/filename based pattern or ALL entries in both lists;
  159.  
  160. QUIT
  161.     Quit from the client. If there are active file transfers, a second
  162.     chance is given.
  163.  
  164. RAW <number> [<args>]
  165.     sends a raw server command. Most useful during debugging.
  166.  
  167. RBIND
  168.     Show a key for particular bind.
  169.  
  170. RESUME
  171.     Shows files which can be resumed
  172.  
  173. RELOAD
  174.     reloads the ~/.BWap/BWap.sav file
  175.  
  176. REQUEST <nick> <exact filename/path>
  177.     attempts to grab a file from nick.
  178.  
  179. RESUME
  180.     currently under development.
  181.  
  182. S
  183.     alias for /SEARCH
  184.  
  185. SAVE
  186.     saves the ~/.BWap/BWap.sav file will ALL your /set's
  187.  
  188. SAY <text>
  189.     send text to current channel.
  190.  
  191. SCAN [channel]
  192.     display internal nicklist from current_channel or channel.
  193.  
  194. SEARCH [-type audio/video/image|-any|-maxresults #|-bitrate #|-freq #|
  195.     -line#|] pattern    
  196.     -type is only supported under opennap servers.
  197.     -maxresults > 100 is not possible. it IS a server limitation.
  198.  
  199. SERVER [-add arg] [-create] [server:port:nick:password:meta]
  200.     display server list.
  201.     -add will add a server to the list without connecting.
  202.     -create to create account on server.
  203.  
  204. SET 
  205.     Set's various options used within the client.
  206.  
  207. SHARE [-load [filename]|-save [filename]|-share|-clear|-unshare|
  208.         -type mimetype|-reload|-recurse|-remove "pattern"] [dir dir1]
  209.     This particular command is fairly complicated. In it's simplest form
  210.     the following 4 commands will do what is most often needed.
  211.  
  212.         /share /home/mp3    scans /home/mp3 recursively for mp3's
  213.         /share -save        saves the shared.dat file
  214.         /share -load        loads the shared.dat file
  215.         /share -share        actually shares the files with the
  216.                     server
  217.  
  218.         -type can be used to specify a particular "mime" type from
  219.         the following list. video, audio, image, any    
  220.         -reload will scan the directory, and search for any missing
  221.         files
  222.         -clear will clear the internal list of files and notify the
  223.         server that we are no longer sharing
  224.         -update will check the internal filelist against your HD
  225.         files to see if they exist. If a file is found that doesn't
  226.         exist, then it is removed and if the server knows about it,
  227.         the server is notified
  228.         -recurse is a toggle to turn off/on the directory recursion.
  229.         -remove will remove the "pattern" specified
  230.  
  231. SIGNORE ["pattern(s)"]
  232.     Inorder to ignore certain "404" msgs from the server (usually
  233.     moderator or better) a server ignore was implemented.. The pattern
  234.     is a quoted string which you wish to ignore in the future. You can
  235.     use *'s to match multiple words and % to replace a single word in
  236.     the string. Multiple patterns may be specified.
  237.         /signore "Notification from %: % % - configured data port *
  238.             unreachable"
  239.         would ignore the following msg -
  240. Notification from q: qr1 (255.255.255.255) - configured data port 6699 unreachable
  241.  
  242. STATS
  243.     displays various statistics.
  244.  
  245. SOUNDEX
  246.     See search. This attempts to use a soundex for mispelted words.
  247.     only supported on opennap servers.
  248.  
  249. TIMER
  250.     Does a periodic event. Based on the irc client BitchX.
  251.  
  252. TOPIC
  253.     Display the topic for a channel.
  254.  
  255. TYPE
  256.  
  257. VERSION
  258.     display the version of BWap.
  259.  
  260. W [nick]
  261.     Displays whois of yourself or specified nick.
  262.  
  263. WHOIS
  264.     See also /W
  265.  
  266. WINDOW
  267.     try /window help