Skip to content

Commit

Permalink
Improve notify-send-headless documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xolox committed Apr 21, 2016
1 parent 040994b commit 1351807
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
4 changes: 4 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ The `proc` package was created with the following considerations in mind:
possibilities of the `proc` package and as a practical tool that is ready
to be used on any Linux system that has Python and cron_ installed.

4. **The proc.notify module:** Implements the command line program
``notify-send-headless`` which can be used to run the program
``notify-send`` in headless environments like cron jobs and system daemons.

History
-------

Expand Down
4 changes: 2 additions & 2 deletions proc/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# proc: Simple interface to Linux process information.
#
# Author: Peter Odding <peter@peterodding.com>
# Last Change: April 21, 2016
# Last Change: April 22, 2016
# URL: https://proc.readthedocs.org

"""
Expand All @@ -13,4 +13,4 @@
"""

# Semi-standard module versioning.
__version__ = '0.8.3'
__version__ = '0.8.4'
8 changes: 5 additions & 3 deletions proc/notify.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# proc: Simple interface to Linux process information.
#
# Author: Peter Odding <peter@peterodding.com>
# Last Change: April 21, 2016
# Last Change: April 22, 2016
# URL: https://proc.readthedocs.org

"""
Expand All @@ -22,8 +22,10 @@
already useful :-) example of how the `proc` package can be used to search
through the environments of all available processes. It looks for the variables
in :attr:`REQUIRED_VARIABLES` in the environments of all available processes
and uses the values it finds to run the notify-send program. Given super-user
privileges this should work fine out of the box on any Linux system.
and uses the values it finds to run the notify-send program. It's available on
the command line as ``notify-send-headless`` (which accepts the same arguments
as ``notify-send``). Given super-user privileges this should work fine out of
the box on any Linux system.
.. _cron jobs: http://unix.stackexchange.com/q/111188
.. _notify-send: http://manpages.debian.org/cgi-bin/man.cgi?query=notify-send
Expand Down

0 comments on commit 1351807

Please sign in to comment.