home *** CD-ROM | disk | FTP | other *** search
/ Amiga ACS 1998 #4 / amigaacscoverdisc1998-041998.iso / utilities / rc5-64 / rc564.doc < prev    next >
Encoding:
Text File  |  1997-11-24  |  11.7 KB  |  328 lines

  1.   DISTRIBUTED.NET V2.6401 CLIENT DOCUMENTATION
  2.  
  3. NAME
  4.  
  5.    rc564 - distributed.net RC5-64 client
  6.  
  7. COMMAND LINE OPTIONS:
  8.  
  9.  rc564  [-config] [-test] [-flush] [-fetch] [-update] [-run] [-runoffline]
  10.  [-runbuffers] [-benchmark] [-percentoff] [-nodisk] [-frequent]
  11.  [-nofallback] [-forceunlock [filename]] [-a [keyserver.name.com]]
  12.  [-p [port]] [-e [email@address.com]] [-c [cpuID]] [-l [rc5.log]]
  13.  [-b [# blocks to buffer]] [-h [# hours]] [-n [# blocks in run]]
  14.  [-u [UUE/HTTP]] [-nice #] [-ha [HTTP Proxy]] [-hp [HTTP port]]
  15.  [-in [in-buffer]] [-out [out-buffer]] [-ini [ini-file]]
  16.  [-smtpserver [servername.com]] [-smtpport [port]]
  17.  [-smtpdest [email@address.com]] [ckpoint [ckpoint.rc5]] [-cktime [# min]]
  18.  [-lurk] [-lurkonly]
  19.  
  20.  
  21. DESCRIPTION
  22. This document should help you get your UNIX based client up and running.  Only
  23. slight modifications should be needed for DOS and Gui versions.
  24.  
  25. Welcome to the wonderful world of distributed computing.  By running this
  26. client on your computer, you are joining a network of thousands of other
  27. computers working on a common goal.
  28.  
  29. The client attempts to read a configuration file, rc564.ini, or filename.ini,
  30. depending upon what you have named the client.  But, you can override that
  31. option by setting th $RC5INI variable. (ie. setenv RC5INI ~dbaker/rc5/normal.ini)
  32.  
  33. The client takes only a minute of setup and little to no maintence.
  34.  
  35. The following COMMAND LINE ARGUMENTS are available:
  36.  
  37. -config        Invoking the command line above would start the configuration menu
  38.  
  39. -test        Tests the client's integrity and ensures it contains no errors
  40.  
  41. -flush        Flushes the output buffers (buff-out.rc5) file by returning all
  42.   the completed blocks back to the keyserver.
  43.  
  44. -fetch        Fills up the input buffer file to the limit by fetching
  45.   additional blocks from the keyserver.
  46.  
  47. -update        Combination of flush/fetch
  48.  
  49. -run        Runs the client in normal mode. Same as just running the file without
  50.   any suffixes. Will on work if the .ini files exists, otherwise,
  51.   the client configuration menu will appear.
  52.  
  53. -runoffline    Runs the client in offline mode. Client does not fetch or flush.
  54.   Client does not fetch or flush it's buffers. If the input buffer
  55.   is empty, the client would generate a random block.
  56.  
  57. -runbuffers    Similary to -runoffline except that this will cause the client
  58.   to exit when it is out of buffers, instead of generating random
  59.   blocks.
  60.  
  61. -benchmark    Benchmarks the client's speed on the system. Use -benchmark2
  62.   if you wish to perform a faster test.
  63.  
  64. -forceunlock [filename]
  65.  Unlock filename
  66.  
  67. -a [keyserver.name.com]
  68.  Specifies the address of the keyserver, where {address} is the name of the
  69.  keyserver you wish to use. This is best if you have a personal proxy that
  70.  you wish to point your client to.
  71.  
  72.  
  73. -p [port]
  74.  Specifise the port of the keyserver to which you want your client to
  75.  connect to
  76.  
  77. -e [email@address.com]
  78.  Specifies the email address you wish to report to the keyserver as.
  79.  Please use your own VALID email address and not your teams email address.
  80.  
  81. -c [cpuID]
  82.  Type of CPU type are as follows:
  83.      -1  : Auto detect
  84.       0  : Intel Pentium, Intel Pentium MMX, Cyrix
  85.      1  : Intel 80386 (386), Intel 80486 (486)
  86.       2  : Intel Pentium Pro, Intel Pentium II
  87.       3  : AMD 486, Cyrix 6x86/6x86MMX/M2
  88.       4  : AMD K5
  89.       5  : AMD K6
  90.  
  91.  NOTE: This might not always match your chip.  You may have a K6
  92.        and it says you have a 486. This is only because it is choosing
  93.        which chip core works FASTEST in a small test.  If you don't believe
  94.        it, try each option in -benchmark and see for yourself.
  95.  
  96.  (THIS IS ONLY AN OPTION IF YOU ARE RUNNING A X86 CLIENT.)
  97.  
  98. -l [rc5.log]
  99.  Name of logfile to log all events to. Leaving it blank would denote no log
  100.  file.
  101.  
  102. -b [# blocks to buffer]
  103.  Blocks to buffer. If first option is used, the input and output buffers
  104.  would be  of the same size. The second option would allow the individual
  105.  settings of the input and the output buffer.
  106.  
  107. -h [# hours]
  108.  Time to limit the client to run for in hours
  109.  
  110. -n [# blocks in run]
  111.  Blocks to complete in a run, where blocks are integers of <= 0. Setting
  112.  it at 0 would mean that there is no limit.
  113.  
  114. -u [UUE/HTTP]]
  115.  Sets the UUE/HTTP mode
  116.  
  117. -nice [#]
  118.  Niceness to run at where :
  119.    0  : Very nice. DOES NOT intefere with system operations. Runs on idle CPU time
  120.    1  : Runs with slightly higher priority than idle processes.
  121.    2  : Runs as a normal process with higher priority.
  122.  
  123. -ha [HTTP Proxy]
  124.  Specifies the address of the HTTP proxy to connect to
  125.  
  126. -hp [HTTP port]
  127.  Port of the HTTP proxy at which the client should connect to
  128.  
  129. -in [in-buffer]
  130.  Overrides the default name of the input buffer to your desired filename
  131.  
  132. -out [out-buffer]
  133.  Overrides the default name of the output buffer to your desired filename
  134.  
  135. -ini [ini-file]
  136.  Overrides the default INI file
  137.  
  138. -smtpserver [servername.com]
  139.  Name of your SMTP server
  140.  
  141. -smtpport [port]
  142.  Port of your SMTP server. Default is at 25
  143.  
  144. -smtpdest [email@address.com]
  145.  Destination of of mail, ie your email address
  146.  
  147. -ckpoint [ckpoint.rc5]
  148.  Specifies the name of the checkpoint file where the clients work on a block
  149.  is recorded. This is especially usefull to ensure your work is not lost in
  150.  the event is is especially usefull to ensure your work is not lost in the
  151.  event of a power failure or system crash. The normal filename is ckpoint.rc5
  152.  
  153. -cktime [# min]
  154.  Time in minutes at which the client would save it's current work on
  155.  a particular blocks to the checkpoint file.
  156.  
  157. -frequent
  158.  Attempt to update(fetch/flush buffers) often
  159.  
  160. -nofallback
  161.  In case it can't contact the specified proxy, don't attempt to
  162.  contact the round robin of rc5proxy.distributed.net keyservers.
  163.  
  164. -lurk
  165.  The client will go out to the network if it sees that it has anything
  166.  to report/request when it sees that a network connection is available. This
  167.  is best for dialup users who don't have a dedicated connection.
  168.  
  169. -lurkonly
  170.  Basically like -lurk, but it effectively works in "offline" mode when
  171.  there is no network connection present.
  172.  
  173. --
  174.  
  175. INI KEYWORDS
  176.  
  177. percentprintingsoff=1
  178. connectoften=1
  179. nodiskbuffers=1
  180. quietmode=1
  181. nofallback=1
  182. checkpoint_min=#
  183. nettimeout=#
  184. noexitfilecheck=1
  185. win95hidden=1
  186. lurk=1
  187.  
  188. These are the special commands that you can add to the .ini on top
  189. of the preconfigured one that the client will automatically create.
  190.  
  191. For help with these commands, or to understand what they do, read
  192. about them in the command line arguments section.
  193.  
  194. --
  195. When you first run the client, it will take you to a configuration like
  196. this one:
  197.  
  198. CLIENT CONFIG MENU
  199. ------------------
  200. 1)  Email to report as [default:rc5@distributed.net] ==> rc5@distributed.net
  201. 2)  Blocks to Buffer [in:out] [default:5] ==> 5:5
  202. 3)  Blocks to complete in run [default:0] ==> 0
  203. 4)  Hours to complete in a run [default:0] ==> 0
  204. 5)  Keys per timeslice - for Macs etc [default:65536] ==> 65536
  205. 6)  Level of niceness to run at [default:0] ==> 0
  206. 7)  File to log to [default:] ==>
  207. 8)  Network communication mode [default:1] ==> 1
  208. 15)  Optimize performance for CPU type [default:-1] ==> -1
  209. 16)  Message Mailing (bytes) [default:0] ==> 0
  210. 22)  Checkpoint information filename [default:none] ==> none
  211. 0)  Quit and Save
  212. Choice -->
  213.  
  214. Enter the number and then press the [ENTER] key, and it will prompt you
  215. for the correct configuration.
  216.  
  217. 1) This is the email address that will show up in the statistics
  218.    page (http://rc5stats.diststributed.net).  It is also the address
  219.    mailed if you find the key!  This needs to be your personal address,
  220.    (not a team's), and it needs to be a valid one!
  221.  
  222. 2) This is how many blocks you want to save before communicating with
  223.    the proxies.  "In" blocks are the number to get from the proxy.  If you
  224.    don't have a dedicated Internet connection, you want to buffer a lot
  225.    of incoming ones, so your computer has a lot of work to do and won't
  226.    run out. This is also good in case the proxies go down or something. The
  227.    outgoing blocks are just how many to save up before it tries to send
  228.    the blocks in.
  229.  
  230.    If you only dialup once a day, I would enter 200 for both those options
  231.    and then once a day when you're connected, type in: "./rc564 -update". That
  232.    will get all the incoming blocks, and flush all the outgoing blocks.
  233.  
  234. 3) The client will do x number of blocks and then exit. Simple enough? :)
  235.  
  236. 4) The client will work for x hours and then exit. Simple enough? :)
  237.  
  238. 5) This should be left alone for optimal performance.
  239.  
  240. 6) This allows you to select different modes of niceness.  If you have
  241.    it on '0', which is 'very nice', other programs on your computer will
  242.    be given cpu priority over the client. You also have options 1 and 2. The
  243.    higher the number, the more cpu the client uses, and the less your other
  244.    programs have. (0 should usually be good)
  245.  
  246. 7) This is simply a file to log to. It will log to the directory in which
  247.    you started the client.  So, you might want to specify a pathname.
  248.  
  249. 8) Here are the different modes:
  250.  
  251.   mode 1) I can communicate freely to the Internet on all ports.
  252.  
  253.  This means you have a regular Internet connection and you
  254.  are not behind a firewall that will restrict any of your Internet
  255.  actions.
  256.  
  257.   mode 2) I can communicate freely on telnet ports
  258.  
  259.  This means that you are behind a firewall but you have access
  260.  to open connections to port 23 (telnet port).
  261.  
  262.   mode 3) I can communicate freely on telnet ports, but need uuencoding
  263.  
  264.  This is if you have access to telnet ports but you tried #2 and
  265.  it failed. Give this a shot.
  266.  
  267.   mode 4) I have a local HTTP proxy that I can go through
  268.  
  269.  This allows you to specify your HTTP proxy, if you have one.  If
  270.  you need to to do this to get around your firewall, it will be the
  271.  same HTTP proxy and ports as in Netscape or MSIE or whatever.
  272.  
  273.   mode 5) Let me specify custom network settings (expert mode)
  274.  
  275.  You're on your own.  This is where you might specify a personal proxy
  276.  or if you love a certain full proxy like rc5.cuckoo.com because you
  277.  like the Danielle Fishel messages, this is your place.
  278.  
  279. 15) This is where you can try different CPU optimizations to see which one
  280.     is faster.  If you leave it at '-1', it will try and detect which
  281.     core is the fastest.  That will usually work.
  282.  
  283. 16) This is how many bytes to wait for in the log file before sending you
  284.     an email.  If you leave this blank, you'll never get a message.  If you
  285.     give it a number, you also have to specify your SMTP server, etc, which you
  286.     can get from your sendmail, elm, pine, Network, or Eudora settings.
  287.  
  288. 22) This is where you can specify a file for the client to write it's progress
  289.     in case the machine crashes or loses power, you won't lose the work you've
  290.     been recently working on. Setting it to 'ckpoint.rc5' is fine.
  291.  
  292.  
  293. Woohoo! You've just configured your client for operations. If you start it
  294. up:
  295.  
  296. ./rc564
  297.  
  298. or
  299.  
  300. ./rc564 >& /dev/null&
  301.  
  302. is what I do.
  303.  
  304. If you want to override the configuration with a command line options,
  305. type in:
  306.  
  307. ./rc564 HELP
  308.  
  309. and it will give you a list of command line options with descriptions of
  310. how they need to work.
  311.  
  312.  
  313.  --    --    --    --    --    --    --    --
  314. If you have comments/additions/questions/complaints/rants/moos about this
  315. FAQ, please send them to dbaker@cuckoo.com.
  316.  
  317. Some CLI options compliments of kiddo <Alex>. (He says: Hi Claire)
  318.  
  319. Copyright distributed.net 1997 - All Rights Reserved
  320. For use in distributed.net projects only.
  321. Any other distribution or use of this program violates copyright.
  322.  
  323. Use of this client or it variants implies agreement with
  324. the prize terms listed on http://www.distributed.net/rc5/
  325.  
  326. Hi to Danielle Fishel, the angel,  and a M00 to 'da Cow. -Daniel [dbaker@cuckoo.com]
  327.  
  328.