freepopsd - FreePOPs daemon

freepopsd [options]

This manual page documents briefly the freepopsd daemon.

freepopsd is a program that converts your local requests to its pop3 daemon to remote http requests to supported web mails.

-p port, --port port

Starts freepopsd on that port. Default is 2000.

-t max, --threads max

Allows max simultneous connections. 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

-P proxyaddress:proxyport, --proxy proxyaddress:proxyport

You can specify the http proxy name and port separated by :. If no port is specifyed 8080 is used by default. You may also export some environment variables instead of using the -P switch, in priority order: HTTP_PROXY, http_proxy, PROXY and proxy. If the proxy needs authentication you have to use the -A switch. If you specify -P -, you will force direct connections to the web, without using any proxy server, despite enviromental variable settings.

-A username:password, --auth username:password

This switches on the basic authentication method. Must be used with the -P switch or one of its alternative forms.

-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.

-k, --kill Kills a running freepopsd.

-x pluginfile, --toxml pluginfile

Prints on standard output the XML description of the plugin.

-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.

--fpat authtype, --force-proxy-auth-type authtype Force the use of a specific proxy auth method. Accepted types are basic, digest, ntlm and gss.

-h, --help Prints the usage message.

-v, --verbose Prints debug statements. Can be repeated to give more verbosity (see -vv).

-vv, -v -v, -w, --veryverbose Prints even more debug statements, detailing most operations performed. This is the maximum verbosity level available. Combining more parameters of this kind won't give you more.

-V, --version Prints the program version.

/usr/share/frepops/lua/*

Webmails access implementation

/etc/freepops/config.lua

Configuration file, interesting only for paths, addresses to modules binding, and accept/reject policy on mail addresses

This manual page was written by Enrico Tassi <gareuselesinge@users.sourceforge.net>, for the Debian project (but may be used by others).