4 FreePOPs command line parameters

The real FreePOPs configuration is made trough command line arguments. They are described in depth in the man page in Unix environments and below. Keep in mind that in normal usage situations it's not necessary to use any of these, but if you have special needs it's useful to use the following list as reference:

-p <port>, - -port <port>

By default FreePOPs binds on port 2000. To alter this behavior just use this switch.

-t <num>, - -threads <num>

FreePOPs is able to manage multiple connections, up to num. Default is 5.

-b addr, - -bind addr

Binds over addr instead INADDR_ANY (0.0.0.0). addr must be a character string containing an IPv4 network address in the dotted-quad format, ``ddd.ddd.ddd.ddd'' or a host name.

-l logfacility, - -logmode logfacility

Can be used to specify the logging facility. logfacility can be ``stdout'' for stdout (the default), ``syslog'' to use the logging daemon or a valid filename to log to this file.

-d, - -daemonize

Moves the process to background releasing the tty.

-n, - -no-pid-file

Do not generate the file containing the process' pid in /ver/run/.

-P <host>:<port>, - -proxy <host>:<port>

To tell FreePOPs which is your HTTP proxy. If port is not set then the default 8080 is used.

-A <username>:<password>, - -auth <username>:<password>

For proxies with basic authentication, to specify username and password. Must be used with -P or its long form.

-u name, - -useragent name

Use this useragent in http connections. The default is ``Firefox/0.8''. A valid example is mozilla's ``Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.5) Gecko/20031024 Debian/1.5-2''.

-s user.group, - -suid user.group

This option is used to make freepopsd drop root privileges after binding. If you run it as a normal user there is no need to use this option. (Not used under Windows)

-k, - -kill

Terminates a running FreePOPs program. (Not used under Windows)

-x pluginfile, - -toxml file

Prints on standard output the XML description of the plugin or module.

-e scriptfile args..., - -execute scriptfile args...

This is a full bloated LUA interpreter, the executed script has access to all freepops libraries. The interpreter calls the main function that must get a table of strings and return an integer. The arguments passed to freepopsd after the script file name are put inside the table argument. The return value is returned from the interpreter.

-c, - -conffile file

Users the specified configuration file instead of looking in default paths like /etc/freepops/config.lua, ./config.lua and /usr/share/frepops/lua/config.lua

- -statistics-all

Enable all statistics. Results can be viewed with the monitor plugin, either with an account like foo@monitor?command=stats or with freepopsd -e monitor host port password command.

- -statistics-session-created

Enables statistics regarding threads created to run a plugin. See the documentation of - -statistics-all for an explanation of how to read that statistics.

- -statistics-session-ok

Enables statistics regarding sessions ended successfully. See the documentation of - -statistics-all for an explanation of how to read that statistics.

- -statistics-session-err

Enables statistics regarding sessions ended with an error. See the documentation of - -statistics-all for an explanation of how to read that statistics.

- -statistics-connection-established

Enables statistics regarding connections accepted. See the documentation of - -statistics-all for an explanation of how to read that statistics.

- -statistics-cookies

Enables statistics regarding persistently stored data (usually cookies). See the documentation of - -statistics-all for an explanation of how to read that statistics.

- -statistics-pwd-file file

Data collected by the statistics mechanism can be read using the monitor plugin. If a password file is not specified, no password is set and everybody connection to the freepops daemon can read such data. Write your password in a text file with no additional end-of-line to restrict access to that data. The password file is read before dropping privileges (on unix).

- -fpat authtype, - -force-proxy-auth-type authtype

To forse a specific proxy auth method. Accepted values are: ntlm, basic, digest e gss.

- -no-icon

To disable the win32 systray icon (windows only).

-h, - -help

Prints the usage message.

-v, - -verbose, -w, - -veryverbose

This tells FreePOPs to log some interesting info for bug reporting.

In posix environments like Debian GNU/Linux you can start FreePOPs at boot time as a standard service. In this case the command line switches are stored in /etc/default/freepops, in some rpm based systems you should find the same file as /etc/sysconfig/freepops.