Hi Lucas, I updated the manpages from the git repo with a "usage on regular bases" paragraph and also added a paragraph about support for http proxy added in bug #726403 (in which I forgot the documentation update).
Please find attached the 2 updated files. Please tell me if the added paragraphs fits you. Best regards, Joseph
how-can-i-help(1)
================
:doctype: manpage
NAME
----
how-can-i-help - show opportunities for contributing to Debian
SYNOPSIS
--------
*how-can-i-help* ['-ahq'] ['--help'] ['--all'] ['--quiet']
DESCRIPTION
-----------
*how-can-i-help* hooks into APT to list opportunities for contributions to
Debian (orphaned packages, bugs tagged 'gift') for packages installed
locally, after each APT invocation. It can also be invoked directly, and
then lists all opportunities for contribution (not just the new ones).
OPTIONS
-------
Options must come before the other command line arguments.
*-h*, *--help*::
Show some help.
*-a*, *--all*::
Show all opportunities for contribution.
*
*-q*, *--quiet*::
Do not display header and footer.
PROXY SUPPORT
-------------
*how-can-i-help* uses the HTTP_PROXY (or http_proxy) environment variable as
http
proxy configuration. Be carefull when using how-can-i-help directly with the
sudo command, you must have set the http_proxy variable in root's bashrc and
launch the sudo command with a '-i' option.
As it is executed after the APT invocations, the same configuration applies when
using APT with sudo.
RUNNING ON REGULAR BASIS
------------------------
You can run how-can-i-help in a cron job as normal (sudoer) user so that you
recieve a mail when new things are reported. To recieve only mails when new
contributions are recieve, use the '-q' flag.
NOTE: As a normal user, how-can-i-help always runs with the --all option, so it
would pop a mail every time cron job runs. Use it behind a 'sudo' to be able
to only have a mail when new help is needed.
WARNING: If you are behind a proxy, then you will have to use a 'sudo -i'. This
will generate a mail with the 'stdin: is not a tty' message each time the job
runs. +
The solution is to replace the 'mesg n' line by 'tty -s && mesg n' in root's
profile.
Crontab example:
-----
00 08 * * * /usr/bin/sudo how-can-i-help -q
-----
ADDITIONAL PACKAGES
-------------------
*how-can-i-help* can also monitor packages not installed locally. These are
listed in ~/.config/how-can-i-help/packages separated by whitespaces or
newlines.
For example one can monitor all package from a server as follow:
# ssh myserver dpkg -l | tail -n+5 | awk '{ print $2 }' \
>> ~/.config/how-can-i-help/packages
SEE ALSO
--------
https://wiki.debian.org/how-can-i-help
AUTHOR
------
Lucas Nussbaum ([email protected])
DATE
----
2013-10-30
// vim: set filetype=asciidoc:
how-can-i-help.1
Description: Binary data
