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/13 22:42] – Make it easier to link to a particular option xuesheng | optionreference [2010/03/21 17:03] – Current release is 1.1.1 xuesheng | ||
---|---|---|---|
Line 36: | Line 36: | ||
! () \\ in some cases this is needed to [[HowTos: | ! () \\ in some cases this is needed to [[HowTos: | ||
- | ? | + | ? |
- | ! (**delete**, | + | ! (**delete**, |
+ | |||
+ | ? | ||
+ | ! (**4294967295**, | ||
? | ? | ||
! (**[**, some char/ | ! (**[**, some char/ | ||
- | ? | + | ? |
- | ! (**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. |
? | ? | ||
Line 56: | Line 59: | ||
===== Configuration Module Options ===== | ===== Configuration Module Options ===== | ||
- | ? | + | ? |
- | ! (**5**) \\ the interval (in seconds) when POPFile checks the " | + | ! (**5**) \\ the interval (in seconds) when POPFile checks the " |
? | ? | ||
Line 65: | Line 68: | ||
? | ? | ||
- | ! (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 [[# |
? | ? | ||
Line 154: | Line 157: | ||
===== Logger Options ===== | ===== Logger Options ===== | ||
+ | |||
+ | 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. |
? | ? | ||
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). | ||
- | ? | + | ? |
- | ! (**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 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 224: | Line 229: | ||
===== 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.0) 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.