Man Linux: Main Page and Category List

NAME

       freepopsd - FreePOPs daemon

SYNOPSIS

       freepopsd [options]

DESCRIPTION

       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.

OPTIONS

        -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

        -n, --no-pid-file
              Don’t  create  the  pid  file  containing  the  process  id   in
              /var/run/.

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

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

       -c, --conffile file
              Users the specified configuration file  instead  of  looking  in
              default  paths  like  /etc/freepops/config.lua, ./config.lua and
              /usr/share/freepops/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).

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

FILES

       /usr/share/freepops/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

AUTHOR

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

                               October 27, 2007