This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
optionreference [2009/06/07 15:16] – Add information about the new option 'bayes_subject_mod_pos' amatubu | optionreference [2010/03/21 17:05] – Current release is 1.1.1 xuesheng | ||
---|---|---|---|
Line 15: | Line 15: | ||
===== Classifier Options ===== | ===== Classifier Options ===== | ||
- | ? bayes_corpus | + | ? |
! (**corpus**, | ! (**corpus**, | ||
- | ? bayes_database | + | ? |
! (**popfile.db**, | ! (**popfile.db**, | ||
- | ? bayes_dbauth | + | ? |
! | ! | ||
- | ? bayes_dbconnect | + | ? |
! (**dbi: | ! (**dbi: | ||
- | ? bayes_dbuser | + | ? |
! | ! | ||
- | ? bayes_hostname | + | ? |
! (**the host name of your machine**) \\ in some cases this is needed for a working [[Glossary: | ! (**the host name of your machine**) \\ in some cases this is needed for a working [[Glossary: | ||
- | ? bayes_localhostname | + | ? |
! () \\ in some cases this is needed to [[HowTos: | ! () \\ in some cases this is needed to [[HowTos: | ||
- | ? bayes_sqlite_journal_mode | + | ? |
- | ! (**delete**, | + | ! (**delete**, |
- | ? bayes_subject_mod_left | + | ? |
+ | ! (**4294967295**, | ||
+ | |||
+ | ? | ||
! (**[**, some char/ | ! (**[**, some char/ | ||
- | ? 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. |
- | ? bayes_subject_mod_right | + | ? |
! (**]**, some char/ | ! (**]**, some char/ | ||
- | ? bayes_unclassified_weight | + | ? |
! (**100**, some factor) \\ this factor determines when a message is marked as unclassified. POPFile must be less than X times more sure that a messages belongs to a given bucket to mark it as unclassified. | ! (**100**, some factor) \\ this factor determines when a message is marked as unclassified. POPFile must be less than X times more sure that a messages belongs to a given bucket to mark it as unclassified. | ||
- | ? bayes_xpl_angle | + | ? |
! (**0**, 1) \\ If set to 1 then the X-POPFile-Link will have < > around the URL (e.g. X-POPFile-Link: | ! (**0**, 1) \\ If set to 1 then the X-POPFile-Link will have < > around the URL (e.g. X-POPFile-Link: | ||
===== Configuration Module Options ===== | ===== Configuration Module Options ===== | ||
- | ? config_pidcheck_interval | + | ? |
- | ! (**5**) \\ the interval (in seconds) when POPFile checks the " | + | ! (**5**) \\ the interval (in seconds) when POPFile checks the " |
- | ? config_piddir | + | ? |
! (**./**, some dir) \\ the relative path to a directory where POPFile will place its " | ! (**./**, some dir) \\ the relative path to a directory where POPFile will place its " | ||
===== Global Options ===== | ===== Global Options ===== | ||
- | ? 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 [[# |
- | ? GLOBAL_last_update_check | + | ? |
! Stores the date (machine readable) of the last check for updates. | ! Stores the date (machine readable) of the last check for updates. | ||
- | ? GLOBAL_message_cutoff | + | ? |
! (**100000**) \\ The maximum size (in bytes) of a message that gets parsed by POPFile. The rest is discarded. A value of 0 denotes no thresshold, i.e. the complete message is parsed regardless of its size. | ! (**100000**) \\ The maximum size (in bytes) of a message that gets parsed by POPFile. The rest is discarded. A value of 0 denotes no thresshold, i.e. the complete message is parsed regardless of its size. | ||
- | ? GLOBAL_msgdir | + | ? |
! (**messages/ | ! (**messages/ | ||
- | ? GLOBAL_timeout | + | ? |
! (**60**, some number of seconds) \\ The timeout value for POP3 connections. | ! (**60**, some number of seconds) \\ The timeout value for POP3 connections. | ||
- | ? GLOBAL_update_check | + | ? |
! (**0**, 1) \\ Determines whether POPFile should check for updates (1) or not (0). | ! (**0**, 1) \\ Determines whether POPFile should check for updates (1) or not (0). | ||
===== History Options ===== | ===== History Options ===== | ||
- | ? history_archive | + | ? |
! (**0**, 1) \\ determines whether messages removed from the history are archived (1) or not (0). | ! (**0**, 1) \\ determines whether messages removed from the history are archived (1) or not (0). | ||
- | ? history_archive_classes | + | ? |
! This is an advanced setting which will save archived files to a randomly numbered sub-directory, | ! This is an advanced setting which will save archived files to a randomly numbered sub-directory, | ||
- | ? history_archive_dir | + | ? |
! (**archive**, | ! (**archive**, | ||
- | ? history_history_days | + | ? |
! (**2**, some number) \\ number of days to keep messages in the history. | ! (**2**, some number) \\ number of days to keep messages in the history. | ||
===== User Interface Options ===== | ===== User Interface Options ===== | ||
- | ? html_cache_templates | + | ? |
! (**0**, 1) \\ Whether or not the HTML:: | ! (**0**, 1) \\ Whether or not the HTML:: | ||
- | ? html_column_characters | + | ? |
! (**0**, any number) \\ This is set by the ' | ! (**0**, any number) \\ This is set by the ' | ||
- | ? html_columns | + | ? |
! (**+inserted, | ! (**+inserted, | ||
- | ? html_date_format | + | ? |
! (**empty string**, some format string) | ! (**empty string**, some format string) | ||
- | ? html_language | + | ? |
! (**English**, | ! (**English**, | ||
- | ? html_last_reset | + | ? |
! Stores the date (in human readable text format) of the last reset of the POPFile statistics. | ! Stores the date (in human readable text format) of the last reset of the POPFile statistics. | ||
- | ? html_local | + | ?html_local |
! (0, **1**) \\ Determines whether POPFile should accept http requests from other machines (0) or not (1). | ! (0, **1**) \\ Determines whether POPFile should accept http requests from other machines (0) or not (1). | ||
- | ? html_page_size | + | ? |
! (**20**, some number) \\ The number of messages that are displayed on each page of the history. | ! (**20**, some number) \\ The number of messages that are displayed on each page of the history. | ||
- | ? html_password | + | ? |
! (string of 32 hex chars) \\ The password for the POPFile UI (encrypted). | ! (string of 32 hex chars) \\ The password for the POPFile UI (encrypted). | ||
- | ? html_port | + | ?html_port |
! (**8080**, a port number) \\ The port used for the http interface to the UI. | ! (**8080**, a port number) \\ The port used for the http interface to the UI. | ||
- | ? html_send_stats | + | ? |
! (**0**, 1) \\ Determines whether POPFile should send a daily report of accuracy statistics to getpopfile.org (1) or not (0). A daily summary is shown on the [[/ | ! (**0**, 1) \\ Determines whether POPFile should send a daily report of accuracy statistics to getpopfile.org (1) or not (0). A daily summary is shown on the [[/ | ||
- | ? html_session_dividers | + | ? |
! (0, **1**) \\ Controls whether session dividers should be shown on the history page or not. | ! (0, **1**) \\ Controls whether session dividers should be shown on the history page or not. | ||
- | ? html_show_bucket_help | + | ? |
! (0, **1**) \\ Whether to show help on bucket setup on the history and buckets tab or not. | ! (0, **1**) \\ Whether to show help on bucket setup on the history and buckets tab or not. | ||
- | ? html_show_training_help | + | ? |
! (**0**, 1) \\ Whether to show help on training on the history and buckets tab or not. | ! (**0**, 1) \\ Whether to show help on training on the history and buckets tab or not. | ||
- | ? html_skin | + | ?html_skin |
! (**default**, | ! (**default**, | ||
- | ? html_strict_templates | + | ? |
! (**0**, 1) \\ Whether the template module should die (and make POPFile crash) when the POPFile code sets template variables that are not used in the actual template. Skin authors should set this to 1 to make sure their templates contain all the used variables. | ! (**0**, 1) \\ Whether the template module should die (and make POPFile crash) when the POPFile code sets template variables that are not used in the actual template. Skin authors should set this to 1 to make sure their templates contain all the used variables. | ||
- | ? html_test_language | + | ? |
! (**0**, 1) \\ When set to 1, the UI is switched to a debug mode that enables UI translators to see the strings that they need to find descriptions for in the UI. | ! (**0**, 1) \\ When set to 1, the UI is switched to a debug mode that enables UI translators to see the strings that they need to find descriptions for in the UI. | ||
- | ? html_wordtable_format | + | ? |
! (**empty**, score, prob, freq) \\ Determines whether to show the word table by default in the single message view. The empty string will make POPFile skip the word table, " | ! (**empty**, score, prob, freq) \\ Determines whether to show the word table by default in the single message view. The empty string will make POPFile skip the word table, " | ||
===== Logger Options ===== | ===== Logger Options ===== | ||
- | ? logger_format | + | The log file is enabled or disabled using the [[/ |
- | ! (**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 | + | ? |
! (**0**, 1, 2) \\ Set how detailed the log is. 0 logs critical errors only, 2 logs everything. | ! (**0**, 1, 2) \\ Set how detailed the log is. 0 logs critical errors only, 2 logs everything. | ||
- | ? 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). | ||
===== NNTP Proxy Options ===== | ===== NNTP Proxy Options ===== | ||
- | ? nntp_enabled | + | ? |
! (0, 1) \\ Enables (1) or disables (0) the NNTP module. | ! (0, 1) \\ Enables (1) or disables (0) the NNTP module. | ||
- | ? nntp_force_fork | + | ? |
! (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 | + | ? |
- | ! (**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 |
! (0, **1**) \\ Allow connections only from local machine (1) or also from remote machines (1). | ! (0, **1**) \\ Allow connections only from local machine (1) or also from remote machines (1). | ||
- | ? nntp_port | + | ?nntp_port |
! (**119**) \\ Port at which POPFile is listening for nntp connections. | ! (**119**) \\ Port at which POPFile is listening for nntp connections. | ||
- | ? nntp_separator | + | ? |
! (**:**) \\ Separator character used between login and server strings. | ! (**:**) \\ Separator character used between login and server strings. | ||
- | ? 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 ===== | ||
- | ? pop3_enabled | + | ? |
! (0, **1**) \\ Enable (1) or disable (0) the POP3 module. | ! (0, **1**) \\ Enable (1) or disable (0) the POP3 module. | ||
- | ? pop3_force_fork | + | ? |
! (on windows: **0**, 1; on other OSs: 0, **1**) \\ Fork off a new child process when the proxy is in use. This enables concurrent connections and will make the UI accessible while the POP3 proxy is doing work. This is currently not recommended on windows. | ! (on windows: **0**, 1; on other OSs: 0, **1**) \\ Fork off a new child process when the proxy is in use. This enables concurrent connections and will make the UI accessible while the POP3 proxy is doing work. This is currently not recommended on windows. | ||
- | ? pop3_local | + | ?pop3_local |
! (0, **1**) \\ Allow remote machines to connect to POPFile' | ! (0, **1**) \\ Allow remote machines to connect to POPFile' | ||
- | ? pop3_port | + | ?pop3_port |
! (**110**, some other port) \\ The port at which POPFile is listening for incoming POP3 connections. | ! (**110**, some other port) \\ The port at which POPFile is listening for incoming POP3 connections. | ||
- | ? pop3_secure_port | + | ? |
! (**110**, some other port) \\ The port at which POPFile is listening for incoming secure POP3 connections. | ! (**110**, some other port) \\ The port at which POPFile is listening for incoming secure POP3 connections. | ||
- | ? pop3_secure_server | + | ? |
! (**empty string**) | ! (**empty string**) | ||
- | ? pop3_separator | + | ? |
! (**:**, some character) \\ Separator character used to split up the login information the client sends to POPFile into host name and port separated by a colon on the one side of the character and the login name on the other side. | ! (**:**, some character) \\ Separator character used to split up the login information the client sends to POPFile into host name and port separated by a colon on the one side of the character and the login name on the other side. | ||
- | ? pop3_socks_port | + | ? |
! (**1080**, some other port number) | ! (**1080**, some other port number) | ||
- | ? pop3_socks_server | + | ? |
! (**empty string**) \\ | ! (**empty string**) \\ | ||
- | ? pop3_toptoo | + | ? |
! (**0**, 1) \\ **pop3_toptoo = 0** \\ Any TOP command sent by the mail client is simply proxied to the mail server. No classification attempt is made, no X-Text-Classification header is inserted and no subject modification is attempted. One exception, the ' | ! (**0**, 1) \\ **pop3_toptoo = 0** \\ Any TOP command sent by the mail client is simply proxied to the mail server. No classification attempt is made, no X-Text-Classification header is inserted and no subject modification is attempted. One exception, the ' | ||
- | ? 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 | + | ? |
! (**25**) \\ | ! (**25**) \\ | ||
- | ? smtp_chain_server | + | ? |
! | ! | ||
- | ? smtp_enabled | + | ? |
! (0, 1) \\ | ! (0, 1) \\ | ||
- | ? 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 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 | + | ? |
! (**0**,1) \\ When ' | ! (**0**,1) \\ When ' | ||
- | ? windows_trayicon | + | ? |
! (0,**1**) \\ When ' | ! (0,**1**) \\ When ' | ||
===== XML-RPC Interface Options ===== | ===== XML-RPC Interface Options ===== | ||
- | ? 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 | + | ? |
! (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 | + | ? |
! (**8081**, some number) \\ Port that XMLRPC listens on. | ! (**8081**, some number) \\ Port that XMLRPC listens on. | ||
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.