Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

update in-file manuals and references

  • Loading branch information...
commit e6fb1c2a0abc41390eeb797f1aab04ed48caceb4 1 parent 5b68624
tommyrot authored
Showing with 22 additions and 21 deletions.
  1. +13 −11 nicklinker.php
  2. +1 −1  sss.conf
  3. +8 −9 sss.php
View
24 nicklinker.php
@@ -229,18 +229,20 @@ private function import($file)
private function print_manual()
{
- $man = 'usage: php nicklinker.php [-c <config>] [-i <file>]'."\n"
- . ' php nicklinker.php [-c <config>] [-o <file>]'."\n\n"
+ $man = 'usage: php nicklinker.php [-c <file>] [-i <file>]'."\n"
+ . ' php nicklinker.php [-c <file>] [-o <file>]'."\n\n"
. 'options:'."\n"
- . ' -c Read settings from <config>.'."\n"
- . ' If unspecified sss.conf will be used.'."\n"
- . ' -i Import all user relations from <file> to the database. It is'."\n"
- . ' strongly advised to make an export first to serve as a backup.'."\n"
- . ' All stored user relations in the database will be unset before'."\n"
- . ' reading the contents of <file>. The script will skip all nicks'."\n"
- . ' found in <file> which are not in the database. The syntax of'."\n"
- . ' nicks contained in <file> is case insensitive.'."\n"
- . ' -o Export all user relations from the database to <file>.'."\n";
+ . ' -c <file>'."\n"
+ . ' Read settings from <file>. By default "./sss.conf" is read.'."\n\n"
+ . ' -i <file>'."\n"
+ . ' Import all user relations from <file> into the database. Nicks'."\n"
+ . ' contained in <file> are treated as case insensitive and any'."\n"
+ . ' nicks which are not already present in the database will be'."\n"
+ . ' ignored. *All* stored user relations are unset before reading'."\n"
+ . ' the contents of given <file> so it advisable to make an export'."\n"
+ . ' beforehand to serve as a backup.'."\n\n"
+ . ' -o <file>'."\n"
+ . ' Export all user relations from the database to <file>.'."\n";
exit($man);
}
View
2  sss.conf
@@ -42,7 +42,7 @@ userstats = "false" # Create links on the main statspage to user.php.
nick_minlen = "1" # Minimum length of a nick for it to validate.
nick_maxlen = "255" # Maximum length of a nick for it to validate.
autolinknicks = "true" # Automatically link nicks which are likely to belong
- # to the same user. Used by nicklinker.php.
+ # to the same user.
wordtracking = "true" # Keep track of how many times each word is used.
# Increases parse times in exchange for more stats.
View
17 sss.php
@@ -368,19 +368,18 @@ private function print_manual()
. ' 16 Smileys'."\n"
. ' 32 URLs'."\n"
. ' 64 Words'."\n"
- . ' If this option is omitted the value in "./sss.conf" is used.'."\n"
- . ' The default value is 127 which means all sections are enabled.'."\n\n"
+ . ' If this option is omitted the value from the configuration file'."\n"
+ . ' is used, which is 127 by default. This enables all sections.'."\n\n"
. ' -c <file>'."\n"
- . ' Read settings from <file>. By default sss reads "./sss.conf"'."\n"
- . ' for its configuration.'."\n\n"
+ . ' Read settings from <file>. By default "./sss.conf" is read.'."\n\n"
. ' -i <file|directory>'."\n"
- . ' Parse logfile <file>, or all logfiles in <directory>. After'."\n"
- . ' the (last) logfile has been parsed database maintenance will'."\n"
- . ' commence to verify, sort and index data.'."\n\n"
+ . ' Parse logfile <file>, or all logfiles in <directory>. After the'."\n"
+ . ' last logfile has been parsed database maintenance will commence'."\n"
+ . ' to verify, sort and index data.'."\n\n"
. ' -m'."\n"
- . ' Run database maintenance as is automatically done by sss after'."\n"
+ . ' Run database maintenance as is automatically done after'."\n"
. ' parsing logs. This option exist for the purpose of updating'."\n"
- . ' user records after nicklinking. (Also see "nicklinker.php".)'."\n\n"
+ . ' user records after linking nicks through "nicklinker.php".'."\n\n"
. ' -o <file>'."\n"
. ' Generate statistics and output to <file>.'."\n";
exit($man);
Please sign in to comment.
Something went wrong with that request. Please try again.