Browse Source

Make wrapping consistent at 79-80 characters per line

Conflicts:
	API-README
	FPGA-README
Luke Dashjr 13 years ago
parent
commit
4bdbbc2a88
1 changed files with 38 additions and 40 deletions
  1. 38 40
      API-README

+ 38 - 40
API-README

@@ -913,13 +913,12 @@ true
 Default:
 Default:
  $notify = true;
  $notify = true;
 
 
-Set $notify to false to NOT attempt to display the notify command
-table of data
+Set $notify to false to NOT attempt to display the notify command table of data
 
 
-Set $notify to true to attempt to display the notify command on
-the single rig page
-If your older version of BFGMiner returns an 'Invalid command'
-because it doesn't have notify - it just shows the error status table
+Set $notify to true to attempt to display the notify command on the single rig
+page
+If your older version of BFGMiner returns an 'Invalid command' because it
+doesn't have notify - it just shows the error status table
 
 
 ---------
 ---------
 
 
@@ -935,12 +934,12 @@ This assumes shares are 1 difficulty shares
 Set $checklastshare to false to not do the above checks
 Set $checklastshare to false to not do the above checks
 
 
 'expected' is calculated from the device Mh/s value
 'expected' is calculated from the device Mh/s value
-So for example, a device that hashes at 380Mh/s should (on average)
-find a share every 11.3s
-If the last share was found more than 11.3 x 12 seconds (135.6s) ago,
-it is considered an error and highlighted
-If the last share was found more than 11.3 x 8 seconds (90.4s) ago,
-it is considered a warning and highlighted
+So for example, a device that hashes at 380Mh/s should (on average) find a
+share every 11.3s
+If the last share was found more than 11.3 x 12 seconds (135.6s) ago, it is
+considered an error and highlighted
+If the last share was found more than 11.3 x 8 seconds (90.4s) ago, it is
+considered a warning and highlighted
 
 
 The default highlighting is very subtle
 The default highlighting is very subtle
 
 
@@ -949,8 +948,8 @@ The default highlighting is very subtle
 Default:
 Default:
  $poolinputs = false;
  $poolinputs = false;
 
 
-Set $poolinputs to true to show the input fields for adding a pool
-and changing the pool priorities on a single rig page
+Set $poolinputs to true to show the input fields for adding a pool and changing
+the pool priorities on a single rig page
 However, if $readonly is true, it will not display them
 However, if $readonly is true, it will not display them
 
 
 ---------
 ---------
@@ -958,13 +957,12 @@ However, if $readonly is true, it will not display them
 Default:
 Default:
  $rigs = array('127.0.0.1:4028');
  $rigs = array('127.0.0.1:4028');
 
 
-Set $rigs to an array of your BFGMiner rigs that are running
- format: 'IP:Port' or 'Host:Port' or 'Host:Port:Name'
+Set $rigs to an array of your BFGMiner rigs that are running format: 'IP:Port'
+ or 'Host:Port' or 'Host:Port:Name'
 If you only have one rig, it will just show the detail of that rig
 If you only have one rig, it will just show the detail of that rig
-If you have more than one rig it will show a summary of all the rigs
- with buttons to show the details of each rig -
- the button contents will be 'Name' rather than rig number, if you
- specify 'Name'
+If you have more than one rig it will show a summary of all the rigs with
+ buttons to show the details of each rig - the button contents will be 'Name'
+ rather than rig number, if you specify 'Name'
 e.g. $rigs = array('127.0.0.1:4028','myrig.com:4028:Sugoi');
 e.g. $rigs = array('127.0.0.1:4028','myrig.com:4028:Sugoi');
 
 
 ---------
 ---------
@@ -972,8 +970,8 @@ e.g. $rigs = array('127.0.0.1:4028','myrig.com:4028:Sugoi');
 Default:
 Default:
  $rigipsecurity = true;
  $rigipsecurity = true;
 
 
-Set $rigipsecurity to false to show the IP/Port of the rig
-in the socket error messages and also show the full socket message
+Set $rigipsecurity to false to show the IP/Port of the rig in the socket error
+ messages and also show the full socket message
 
 
 ---------
 ---------
 
 
@@ -981,19 +979,19 @@ Default:
  $rigtotals = true;
  $rigtotals = true;
  $forcerigtotals = false;
  $forcerigtotals = false;
 
 
-Set $rigtotals to true to display totals on the single rig page
-'false' means no totals (and ignores $forcerigtotals)
+Set $rigtotals to true to display totals on the single rig page 'false' means
+ no totals (and ignores $forcerigtotals)
 
 
 If $rigtotals is true, all data is also right aligned
 If $rigtotals is true, all data is also right aligned
 With false, it's as before, left aligned
 With false, it's as before, left aligned
 
 
-This option is just here to allow people to set it to false
-if they prefer the old non-total display when viewing a single rig
+This option is just here to allow people to set it to false if they prefer the
+ old non-total display when viewing a single rig
 
 
-Also, if there is only one line shown in any section, then no
-total will be shown (to save screen space)
-You can force it to always show rig totals on the single rig page,
-even if there is only one line, by setting $forcerigtotals = true;
+Also, if there is only one line shown in any section, then no total will be
+ shown (to save screen space)
+You can force it to always show rig totals on the single rig page, even if
+ there is only one line, by setting $forcerigtotals = true;
 
 
 ---------
 ---------
 
 
@@ -1004,17 +1002,17 @@ Default:
 The numbers are integer seconds
 The numbers are integer seconds
 
 
 The defaults should be OK for most cases
 The defaults should be OK for most cases
-However, the longer SND is, the longer you have to wait while
-PHP hangs if the target BFGMiner isn't running or listening
+However, the longer SND is, the longer you have to wait while PHP hangs if the
+target BFGMiner isn't running or listening
 
 
-RCV should only ever be relevant if BFGMiner has hung but the
-API thread is still running, RCV would normally be >= SND
+RCV should only ever be relevant if BFGMiner has hung but the API thread is
+still running, RCV would normally be >= SND
 
 
-Feel free to increase SND if your network is very slow
-or decrease RCV if that happens often to you
+Feel free to increase SND if your network is very slow or decrease RCV if that
+happens often to you
 
 
-Also, on some windows PHP, apparently the $usec is ignored
-(so usec can't be specified)
+Also, on some windows PHP, apparently the $usec is ignored (so usec can't be
+specified)
 
 
 ---------
 ---------
 
 
@@ -1022,8 +1020,8 @@ Default:
  $hidefields = array();
  $hidefields = array();
 
 
 List of fields NOT to be displayed
 List of fields NOT to be displayed
-You can use this to hide data you don't want to see or don't want
-shown on a public web page
+You can use this to hide data you don't want to see or don't want shown on a
+public web page
 The list of sections are:
 The list of sections are:
  SUMMARY, POOL, PGA, GPU, NOTIFY, CONFIG, DEVDETAILS, DEVS
  SUMMARY, POOL, PGA, GPU, NOTIFY, CONFIG, DEVDETAILS, DEVS
 See the web page for the list of field names (the table headers)
 See the web page for the list of field names (the table headers)