aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 6e7c8be56eaca7d07ba730346022ed73e1df3379 (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# NAME
**parte** simple notification displayer

# SYNOPSIS
**parte** [options] [*text* ...]

# DESCRIPTION
**parte** is a simple notification displayer that accepts input from
standard input or command-line arguments.  
It is highly configurable through its arguments and compile-time options.
Right-clicking the notification may trigger an action.

# EXAMPLE WITHOUT OPTIONS
```sh

    parte "Hello" "This is another line"
    echo "Hello\nThis is another line" | parte
    echo "Hello" | parte "This is another line"
    parte "right clic for echo" && echo "hello world!!"
```
**parte** return 1 in normal circunstances, 2 in errors and 0 when is closed with a right clic, so yo can make a script work only if you decide to (like above).

# EXIT STATUS
**parte** returns:

| Code | Meaning                |
| ---- | ---------------------- |
| `0`  | Closed via right-click |
| `1`  | Normal termination     |
| `2`  | Error occurred         |


# OPTIONS

| Flag                 | Argument    | Description                                                                                        |
| -------------------- | ----------- | -------------------------------------------------------------------------------------------------- |
| `-h`, `-?`, `--help` | —           | Show help and exit.                                                                                |
| `-u`                 | `mode`      | Set notification mode: `low`, `normal`, `urgent` (default: `normal`). Overrides prior style flags. |
| `-t`                 | `seconds`   | Display duration in seconds.                                                                       |
| `-border-size`      | `pixels`    | Border size in pixels.                                                                             |
| `-fg`                | `"#RRGGBB"` | Foreground (font) color.                                                                           |
| `-bg`                | `"#RRGGBB"` | Background color.                                                                                  |
| `-border-color`     | `"#RRGGBB"` | Border color.                                                                                      |
| `-font`              | `pattern`   | Fontconfig pattern for the font.                                                                   |
| `-focus-keyboard`   | —           | Show notification on monitor with keyboard focus.                                                  |
| `-focus-mouse`      | —           | Show notification on monitor under mouse cursor.                                                   |
| `-top-left`         | —           | Place notification in top-left corner.                                                             |
| `-top-right`        | —           | Place notification in top-right corner.                                                            |
| `-bottom-left`      | —           | Place notification in bottom-left corner.                                                          |
| `-bottom-right`     | —           | Place notification in bottom-right corner.                                                         |


# EXAMPLE WITH OPTIONS
```sh

    parte -fg "#FFFFFF" -bg "#000000" "Hello" "This is another line"
    echo "Hello\nThis is another line very urgent" | parte -u "urgent"
    echo "Hello" | ./parte -u "low" -t 3 "This is another line"
```

## INSTALATION

```sh
make config.h
make install clean
```
use sudo if your user needs it.
```sh
make uninstall
```
This will uninstall it.

# LICENCE
Copyright (c) Juan de la Puente Valbuena <softwaredelapuente@gmail.com>
Licensed under the EUPL-1.2 see more details in LICENSE