README.md 2.55 KB
Newer Older
1
Yet Another Dialog
Victor Ananjesky's avatar
Victor Ananjesky committed
2
====================
Victor Ananjesky's avatar
Victor Ananjesky committed
3

Victor Ananjesky's avatar
Victor Ananjesky committed
4
Program allows you to display GTK+ dialog boxes from command line or 
Victor Ananjevsky's avatar
Victor Ananjevsky committed
5
shell scripts. YAD depends on GTK+ only. Minimal GTK+ version is 3.22.0
Victor Ananjesky's avatar
Victor Ananjesky committed
6 7 8

This software is licensed under the GPL v.3

Victor Ananjevsky's avatar
Victor Ananjevsky committed
9
Project homepage: https://github.com/v1cont/yad  
Victor Ananjevsky's avatar
Victor Ananjevsky committed
10
Complex examples: https://github.com/v1cont/yad/wiki/YAD-Examples  
Victor Ananjevsky's avatar
Victor Ananjevsky committed
11
Mailing list: http://groups.google.com/group/yad-common  
Victor Ananjesky's avatar
Victor Ananjesky committed
12

Victor Ananjevsky's avatar
Victor Ananjevsky committed
13
Some miscellaneous stuff can be found in data/misc directory including notify-send script
Victor Ananjesky's avatar
Victor Ananjesky committed
14 15
and simple zenity-compatible wrapper 

Victor Ananjevsky's avatar
Victor Ananjevsky committed
16 17
A fresh gtk2 branch of YAD can be obtained from this repository - https://github.com/step-/yad

18 19
Building git version
----------------------
Victor Ananjesky's avatar
Victor Ananjesky committed
20

Victor Ananjesky's avatar
Victor Ananjesky committed
21 22
Get git version with command

23
git clone https://github.com/v1cont/yad.git yad-dialog-code
Victor Ananjesky's avatar
Victor Ananjesky committed
24 25 26 27

Before run the standard ./configure && make && make install procedure
you need to generate build scripts. This can be done by running command

Victor Ananjevsky's avatar
Victor Ananjevsky committed
28
autoreconf -ivf && intltoolize
Victor Ananjesky's avatar
Victor Ananjesky committed
29

Victor Ananjevsky's avatar
Victor Ananjevsky committed
30 31
You must manually run gtk-update-icon-cache after installation.

Victor Ananjesky's avatar
Victor Ananjesky committed
32 33 34
For successfully build you may need to install the following packages:
* GNU Autotools (https://www.gnu.org/software/autoconf/ http://www.gnu.org/software/automake/)
* Intltool >= 0.40.0 (http://freedesktop.org/wiki/Software/intltool/)
Victor Ananjevsky's avatar
Victor Ananjevsky committed
35
* GTK+ >= 3.22.0 (http://www.gtk.org)
Victor Ananjesky's avatar
Victor Ananjesky committed
36 37 38 39 40
with appropriate *-dev* packages depending on your distro

Additionally, you can build yad with the following libraries:
* Webkit - for supporting HTML dialog (http://webkitgtk.org)
* GtkSourceView - for enabling syntax highlighting in text-info dialog (https://wiki.gnome.org/Projects/GtkSourceView)
Victor Ananjevsky's avatar
Victor Ananjevsky committed
41
* GSpell - for support spell checking in text fields (https://wiki.gnome.org/Projects/gspell)
42 43 44

In standalone build (configure option --enable-standalone) some defaults can be redefined with the following defines

Victor Ananjevsky's avatar
Victor Ananjevsky committed
45 46 47 48 49 50 51
BORDERS - set the default border width around dialog. Default is 5  
REMAIN - if defined, timeout indicator will show the remaining time  
COMBO_EDIT - if defined, combo-box in entry dialog will be always editable  
TERM_CMD - string with terminal command. Default is "xterm -e '%s'"  
OPEN_CMD - string with open command. Default is "xdg-open '%s'"  
DATE_FMT - string with date output format. Default is "%x". See strftime(3) for details  
URI_COLOR - color for URIs in text-info dialog. Default is blue  
52 53
MARK1_COLOR - color for first type of text marks in text-info dialog. Default is lightgreen
MARK2_COLOR - color for second type of text marks in text-info dialog. Default is pink
54 55 56
MAX_TABS - set the number of tabs for tabbed dialog. Default is 100

Defines can be added througs CFLAGS environment variable