POPFile Command Line and Advanced Options

Trace:

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
optionreference [2009/06/13 22:42] – Make it easier to link to a particular option xueshengoptionreference [2010/03/21 19:14] (current) – external edit 127.0.0.1
Line 36: Line 36:
 ! () \\ in some cases this is needed to [[HowTos:SuppressXPLWarning | avoid a warning message]] when clicking the X-POPFile-Link header.  Similar to bayes_hostname but for use in Stealth Mode. ! () \\ in some cases this is needed to [[HowTos:SuppressXPLWarning | avoid a warning message]] when clicking the X-POPFile-Link header.  Similar to bayes_hostname but for use in Stealth Mode.
  
-?bayes_sqlite_journal_mode (added in v1.1.1) +?bayes_sqlite_journal_mode 
-! (**delete**, truncate, persist, memory, off) \\ the journal mode of SQLite database engine. This option is effective when you are using SQLite backend and using DBD::SQLite v1.20 or later. Changing this parameter to 'memory' will make POPFile faster to update its database (adding messages to history, or reclassifying messages to buckets), but if POPFile crashes when it is updating database the database may be corrupted unexpectedly.\\ For more information about the journal mode, please see [[http://www.sqlite.org/pragma.html#pragma_journal_mode|Pragma statements supported by SQLite]].+! (**delete**, truncate, persist, memory, off) \\ the journal mode of SQLite database engine. This option is effective when you are using SQLite backend and using DBD::SQLite v1.20 or later. Changing this parameter to 'memory' will make POPFile faster to update its database (adding messages to history, or reclassifying messages to buckets), but if POPFile crashes when it is updating database the database may be corrupted unexpectedly. ** (added in v1.1.1)**\\ For more information about the journal mode, please see [[http://www.sqlite.org/pragma.html#pragma_journal_mode|Pragma statements supported by SQLite]]. 
 + 
 +?bayes_sqlite_tweaks 
 +! (**4294967295**, some number) \\ the parameter for tweak SQLite database. ** (changed in v1.1.1)**\\ This is a bit mask used to control options when you are using the default SQLite database. By default all the options are on (4294967295 is 0xFFFFFFFF in hexadecimal number). \\ **1 (bit 0) = Synchronous flag**\\ Set the synchronous flag to ''normal''. This value was default of SQLite 2.x. For more information about the synchronous flag, please see [[http://www.sqlite.org/pragma.html#pragma_synchronous|Pragma statements supported by SQLite]].\\ **2 (bit 1) = Backup database**\\ Backup database every hour. The back up file will be stored in the same folder of the original database and its name will be 'popfile.db.backup'.
  
 ?bayes_subject_mod_left ?bayes_subject_mod_left
 ! (**[**, some char/string) \\ the character or string that POPFile will insert to the subject before the bucket name. ! (**[**, some char/string) \\ the character or string that POPFile will insert to the subject before the bucket name.
  
-?bayes_subject_mod_pos (added in v1.1.1) +?bayes_subject_mod_pos 
-! (**1**, -1) \\ the position that POPFile inserts a subject modification.\\ **bayes_subject_mod_pos = 1**\\ POPFile will inserts a subject modification at the **beginning** of the subject.\\ \\ **bayes_subject_mod_pos = -1**\\ POPFile will inserts a subject modification at the **end** the subject.+! (**1**, -1) \\ the position that POPFile inserts a subject modification. ** (added in v1.1.1)**\\ **bayes_subject_mod_pos = 1**\\ POPFile will inserts a subject modification at the **beginning** of the subject.\\ \\ **bayes_subject_mod_pos = -1**\\ POPFile will inserts a subject modification at the **end** the subject.
  
 ?bayes_subject_mod_right ?bayes_subject_mod_right
Line 56: Line 59:
 ===== Configuration Module Options ===== ===== Configuration Module Options =====
  
-?config_pidcheck_interval (added in v1.1.0) +?config_pidcheck_interval 
-! (**5**) \\ the interval (in seconds) when POPFile checks the "popfile.pid" file. POPFile will wait ( config_pidcheck_interval * 2 ) seconds if it find the "pidfile.pid" on startup. If you set it 0, POPFile will never check the pid file. This means that POPFile never checks if the other POPFile process is already running.+! (**5**) \\ the interval (in seconds) when POPFile checks the "popfile.pid" file. POPFile will wait ( config_pidcheck_interval * 2 ) seconds if it find the "pidfile.pid" on startup. If you set it 0, POPFile will never check the pid file. This means that POPFile never checks if the other POPFile process is already running. **(added in v1.1.0)**
  
 ?config_piddir ?config_piddir
-! (**./**, some dir) \\ the relative path to a directory where POPFile will place its "popfile.pid" file when it starts up.+! (**./**, some dir) \\ the relative path to a directory where POPFile will place its "popfile.pid" file when it starts up. The default setting (./) means the file will be stored in the same directory as the configuration file (popfile.cfg).
  
 ===== Global Options ===== ===== Global Options =====
  
 ?GLOBAL_debug ?GLOBAL_debug
-! (0, **1**, 2, 3) \\ This number determines whether and how POPFile will log debug output. 0: no output, 1: to file, 2: to screen, 3: file and screen.+! (0, **1**, 2, 3) \\ This number determines whether and how POPFile will log debug output. 0: no output, 1: to file, 2: to screen, 3: file and screen. See the [[#logger_options| Logger Options]] section for the settings which control the log format and content.
  
 ?GLOBAL_last_update_check ?GLOBAL_last_update_check
Line 108: Line 111:
  
 ?html_date_format ?html_date_format
-! (**empty string**, some format string)  \\ The format used to display the date for messages on the history page. If the default (en empty string) is used, the format string will be read from the currently set language file. See WorldDomination and DateFormat for more detailed information.+! (**empty string**, some format string)  \\ The format used to display the date for messages on the history page. If the default (an empty string) is used, the format string will be read from the currently set language file. See WorldDomination and DateFormat for more detailed information.
  
 ?html_language ?html_language
Line 154: Line 157:
  
 ===== Logger Options ===== ===== Logger Options =====
 +
 +The log file is enabled or disabled using the [[/docs/optionreference#GLOBAL_debug| GLOBAL_debug]] setting.
  
 ?logger_format ?logger_format
-! (**default**) \\ +! (**default**, tabbed, csv) \\ Defines the output format for the log files. default uses a space to separate the fields, tabbed uses a tab character and csv uses a comma.
  
 ?logger_loglevel ?logger_loglevel
Line 162: Line 167:
  
 ?logger_logdir ?logger_logdir
-! (**./**) \\ Name of the directory where the log file is stored. This directory must exist (POPFile will not create it).+! (**./**) \\ Name of the directory where the log file is stored. This directory must exist (POPFile will not create it). The default setting (./) means the log file will be stored in the same directory as the configuration file (popfile.cfg).
  
 ===== NNTP Proxy Options ===== ===== NNTP Proxy Options =====
Line 172: Line 177:
 ! (0, 1) \\ Fork a child process when the proxy is used (1) or don't (0). ! (0, 1) \\ Fork a child process when the proxy is used (1) or don't (0).
  
-?nntp_headtoo (added in v1.1.0) +?nntp_headtoo 
-! (**0**, 1) \\ **nntp_headtoo = 0** \\ Any HEAD command sent by the news client is simply proxied to the news server. No classification attempt is made, no X-Text-Classification header is inserted and no subject modification is attempted. \\  \\ **nntp_headtoo = 1** \\ In this mode, POPFile internally captures the HEAD command from the news client and replaces it with an ARTICLE command issued to the news server. That causes the entire message to get retrieved. POPFile classifies that message and then DOES insert the XTC and DOES perform Subject modification (if appropriate) before it returns the header of the message to the news client. \\  \\ **Note:** setting headtoo to true (1) will mean that every message appears twice in your Popfile History. This will have only a nominal impact though, because the history gets cleared automatically after a few days and overall accuracy should be the same. Either message can be used to reclassify the message within POPFile.+! (**0**, 1) \\ **(added in v1.1.0)**\\ **nntp_headtoo = 0** \\ Any HEAD command sent by the news client is simply proxied to the news server. No classification attempt is made, no X-Text-Classification header is inserted and no subject modification is attempted. \\  \\ **nntp_headtoo = 1** \\ In this mode, POPFile internally captures the HEAD command from the news client and replaces it with an ARTICLE command issued to the news server. That causes the entire message to get retrieved. POPFile classifies that message and then DOES insert the XTC and DOES perform Subject modification (if appropriate) before it returns the header of the message to the news client. \\  \\ **Note:** setting headtoo to true (1) will mean that every message appears twice in your Popfile History. This will have only a nominal impact though, because the history gets cleared automatically after a few days and overall accuracy should be the same. Either message can be used to reclassify the message within POPFile.
  
 ?nntp_local ?nntp_local
Line 185: Line 190:
  
 ?nntp_welcome_string ?nntp_welcome_string
-! (**NNTP POPFile (v1.1.0) server ready**) \\ The string with which connecting news clients are greeted.+! (**NNTP POPFile (v1.1.1) server ready**) \\ The string with which connecting news clients are greeted.
  
 ===== POP3 Proxy Options ===== ===== POP3 Proxy Options =====
Line 220: Line 225:
  
 ?pop3_welcome_string ?pop3_welcome_string
-! (**POP3 POPFile (v1.1.0) server ready**) \\ The string with which connecting mail clients are greeted.+! (**POP3 POPFile (v1.1.1) server ready**) \\ The string with which connecting mail clients are greeted.
  
 ===== SMTP Proxy Options ===== ===== SMTP Proxy Options =====
  
-? smtp_chain_port+?smtp_chain_port
 ! (**25**) \\  ! (**25**) \\ 
  
-? smtp_chain_server+?smtp_chain_server
 ! !
  
-? smtp_enabled+?smtp_enabled
 ! (0, 1) \\  ! (0, 1) \\ 
  
-? smtp_force_fork+?smtp_force_fork
 ! (0, 1) \\  ! (0, 1) \\ 
  
-? smtp_local+?smtp_local
 ! (0, **1**) \\ Allow only local connections (1) or accept also connections from remote machines (0). ! (0, **1**) \\ Allow only local connections (1) or accept also connections from remote machines (0).
  
-? smtp_port+?smtp_port
 ! (**25**) \\  ! (**25**) \\ 
  
-? smtp_welcome_string +?smtp_welcome_string 
-! (**SMTP POPFile (v1.1.0) welcome**) \\ The string with which connecting clients are greeted.+! (**SMTP POPFile (v1.1.1) welcome**) \\ The string with which connecting clients are greeted.
  
 ===== Microsoft Windows Options ===== ===== Microsoft Windows Options =====
  
-? windows_console+?windows_console
 ! (**0**,1) \\ When 'runpopfile.exe' or 'popfile.exe' is used to run POPFile, this determines whether POPFile runs invisibly in the background (0) or in a console (DOS box) window (1). This setting can be changed using a button in the WINDOWS section of the Configuration tab in the POPFile UI. ! (**0**,1) \\ When 'runpopfile.exe' or 'popfile.exe' is used to run POPFile, this determines whether POPFile runs invisibly in the background (0) or in a console (DOS box) window (1). This setting can be changed using a button in the WINDOWS section of the Configuration tab in the POPFile UI.
  
-? windows_trayicon+?windows_trayicon
 ! (0,**1**) \\ When 'runpopfile.exe' or 'popfile.exe' is used to run POPFile, this determines whether the POPFile system tray icon is enabled (1) or disabled (0). This setting can be changed using a button in the WINDOWS section of the Configuration tab in the POPFile UI. The system tray icon can be used to display the POPFile UI or to shutdown POPFile. ! (0,**1**) \\ When 'runpopfile.exe' or 'popfile.exe' is used to run POPFile, this determines whether the POPFile system tray icon is enabled (1) or disabled (0). This setting can be changed using a button in the WINDOWS section of the Configuration tab in the POPFile UI. The system tray icon can be used to display the POPFile UI or to shutdown POPFile.
  
 ===== XML-RPC Interface Options ===== ===== XML-RPC Interface Options =====
  
-? xmlrpc_enabled+?xmlrpc_enabled
 ! (**0**, 1) \\ Enable (1) or disable (0) the XML-RPC module. ! (**0**, 1) \\ Enable (1) or disable (0) the XML-RPC module.
  
-? xmlrpc_local+?xmlrpc_local
 ! (0,**1**) \\ Boolean, true (1) means only accept connections from local machine, false (0) means ok to accept foreign connections. ! (0,**1**) \\ Boolean, true (1) means only accept connections from local machine, false (0) means ok to accept foreign connections.
  
-? xmlrpc_port+?xmlrpc_port
 ! (**8081**, some number) \\ Port that XMLRPC listens on. ! (**8081**, some number) \\ Port that XMLRPC listens on.
  
 
optionreference.1244932930.txt.gz · Last modified: 2009/06/14 00:42 (external edit)
Old revisions

Should you find anything in the documentation that is incomplete, unclear, outdated or just plain wrong, please let us know and leave a note in the Documentation Forum.

Recent changes RSS feed Donate Driven by DokuWiki
The content of this wiki is protected by the GNU Fee Documentation License