mirror of
https://github.com/gryf/wmdocklib.git
synced 2026-01-04 21:04:20 +01:00
1569327 release 1.1 is broken
cleaning up more things. MANIFEST.in includes ll readmes, wmdocklib correctly populated.
This commit is contained in:
97
examples/README
Normal file
97
examples/README
Normal file
@@ -0,0 +1,97 @@
|
||||
[Pywmdatetime]
|
||||
Pywmdatetime is a WindowMaker dockapp for displaying time, date and
|
||||
some other information. The colors and formats are easy to configure
|
||||
through the configuration file or as command line arguments. Invoke
|
||||
the program with --help or see the sample rc-file for more information.
|
||||
|
||||
[Pywmgeneric]
|
||||
Pywmgeneric is a dockapp with five entrys that display the first line of
|
||||
output from an external program, the returned string from an python
|
||||
method or an static string. Three mouse actions can be associated with
|
||||
each displayed entry.
|
||||
|
||||
[Pywmgeneric -- DETAILED]
|
||||
Five different entries can be defined in pywmgeneric. Every entry can
|
||||
have an action, an update_delay and up to three mouse actions associated
|
||||
with it. Some additional options are also available.
|
||||
|
||||
The associated action of an entry is executed with update_delay time
|
||||
between executions. The output from the action is stored. If no special
|
||||
display options are defined, the application will display the first line
|
||||
of output from the action. If it does not fit in the window, it will
|
||||
slowly scroll in the window. Clicking with the mouse on the text invokes
|
||||
one of the mouse actions, depending on which button was pressed. The
|
||||
action can be to execute an external program, to run a python method or
|
||||
to update the text through performing the action associated with the
|
||||
entry. The mouse actions can retreive the text genererated by the timed
|
||||
action.
|
||||
|
||||
Python methods that should be executed as actions should be defined in
|
||||
the class UserMethods. Look in pywmgeneric.py, near the top, for this
|
||||
class and the documentation of how these methods should be defined.
|
||||
Note that the methods allready there only are samples and will probably
|
||||
not work on your system.
|
||||
|
||||
Other options in the configuration file include:
|
||||
scroll = yes|no - en-/disable scrolling of the text when it doesn't fit
|
||||
display = <text> - display a static string instead of the first line of
|
||||
the action-generated output.
|
||||
|
||||
See the sample configuration file for examples and more information.
|
||||
Note that this file is only for reference, it is the one I use. Things
|
||||
will probably not work on your system if you do not change it.
|
||||
|
||||
[Pywmgeneric -- USES]
|
||||
This program is very generic (hence the name ;) ), the uses are many
|
||||
since it is highly configurable.
|
||||
|
||||
I use it for displaying my cpu and system temperatures. I just defined
|
||||
methods for reading two files in the /proc filesystem on my system.
|
||||
|
||||
I also use it for fetching headlines from a newspaper, displaying the
|
||||
first headline fetched. If I click with my left button, all headlines
|
||||
will appear in an xmessage. If I rightclick the headlines along with
|
||||
summaries are displayed, and if I click with my middle button mozilla
|
||||
will fire up showing the newspaper's website.
|
||||
|
||||
I have an external program which displays what's currently on tv,
|
||||
ideal for use with this program I thought! I modified it a bit so
|
||||
it printed a summary line at the top, and voila I have all
|
||||
currently running tv programs scrolling by in an dockapp. And clicking
|
||||
on it shows me the details.
|
||||
|
||||
You could use it as an application launcher, just display the name of
|
||||
the applications and associate mouse actions to lauch them. The
|
||||
xterm-entry in the sample shows this.
|
||||
|
||||
You could probably come up with much more than this!
|
||||
|
||||
[pywmhdmon]
|
||||
pywmhdmon is a WindowMaker dockapp that displays the available space on
|
||||
up to four of your filesystems. It also contains a bar showing the
|
||||
current HD activity. It currently only works on system which has a
|
||||
/proc/stat like file. The application is easy to configure, invoke it
|
||||
with --help or see the sample rc-file for more information.
|
||||
|
||||
[pywmhdmon -- BUGS]
|
||||
The activity bar does not work with the proc filesystem that comes with
|
||||
the 2.6 kernels. It is just a matter of rewriting the app to parse the
|
||||
new format, but I'm low on time personally.
|
||||
|
||||
[Pywmseti]
|
||||
Pywmseti is an WindowMaker dockapp for monitoring your seti@home progress.
|
||||
The application displays how many workunits you have done and the progress
|
||||
on the current one. You start/stop the seti@home process by simply clicking
|
||||
anywhere in the application. It also displays the time spent on the workunit
|
||||
(or since you started the program if you restart it in the middle of a
|
||||
workunit). Invoke the program with --help or see the sample rc-file for
|
||||
more information about customization.
|
||||
|
||||
[pywmsysmon]
|
||||
pywmsysmon is a WindowMaker dockapp that displays your cpu and memory
|
||||
usages. The upper graph shows your cpu usage history and the lower
|
||||
"progress bar" shows your current memory usage excluding cached and
|
||||
buffered data. This program currently only works on systems which got
|
||||
the /proc/stat and /proc/meminfo files available. Invoke the program
|
||||
with --help for information about customization.
|
||||
|
||||
Reference in New Issue
Block a user