summaryrefslogtreecommitdiff
path: root/command/README
blob: 854c8197e735aa7a5a4f67ae3e80bae355a6ba07 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
SUMMARY
-------

MATE Command Applet diplays the output of a commnd on the MATE Panel.

   
PREFERENCES
-----------

- Command: command to execute. The command is executed without a
           shell. If you need shell functionality (pipes, ENV vars,
           etc) use /bin/sh -c 'some shell command'

- Interval: interval in seconds after which the command will be
            executed again

- Maximum width: command output will be truncated to this number of
                 characters (see COMMAND OUTPUT)

- Show icon: enable display of an icon near the command output

COMMAND OUTPUT
--------------

Simple:

The command outputs a single line of text. The text is truncated to
"Maximum width" characters and displayed on the panel.

GKeyFile:

If the output starts with "[Command]", the output is interpreted as
GKeyFile. Valid keys are:

- Output
  Required. Value will be parsed as pango markup and displayed on the
  panel. Truncation to "Maximum Width" is not applied.

- Tooltip
  Optional: When set, the value will be used as tooltip instead of
  the default (the command) and will be displayed, when cursor is
  moved over the applet.

- Icon
  Optional: Filename of an icon to show, when "Show icon" is enabled.
  
EXAMPLES
--------

- Commands with simple output:
  date +%T
  /bin/sh -c 'vmstat -s | grep free.memory'

- GKeyFile command output:

  [Command]
  Output=<span foreground="red">3</span> Warnings
  Tooltip=7 checks ok\n3 checks failed
  Icon=dialog-error