README.md
1# sakura
2
3**sakura** is a simple [gtk](http://www.gtk.org) and [vte](https://gitlab.gnome.org/GNOME/vte) based terminal emulator. It uses tabs to provide several terminals in one window and allows to change configuration options via a contextual menu. No more no less.
4
5## Installation
6
7How to compile and install this beast ?
8
9```bash
10$ cmake .
11$ make
12$ sudo 'make install'
13```
14**sakura** now uses the CMake building system (RIP our old system MOBS, we'll remember you ;)).
15
16To install **sakura** with a different prefix, cmake needs to be invoked with the proper environment
17variables, so for example, to install sakura in `/usr`, you must type:
18
19```bash
20$ cmake -DCMAKE_INSTALL_PREFIX=/usr .
21```
22
23Use CMAKE_BUILD_TYPE=Debug if you need debug symbols. Default type is "Release".
24
25
26## Usage
27
28**sakura** has several command line options. Run `sakura --help` for a full list.
29
30## Keybindings
31
32**sakura** supports keyboard bindings in its config file (`~/.config/sakura/sakura.conf`), but there's no GUI to edit them, so please use your favourite editor to change the following values. Keybindings are a combination of an accelerator+key.
33
34### Accelerators
35
36Accelerators can be set to any _GdkModifierType_ mask value. The full list of _GdkModifierType_ values is available [here](http://gtk.php.net/manual/en/html/gdk/gdk.enum.modifiertype.html)
37
38Mask values can be combined by ORing them. For example, to set the delete tab accelerator to Ctrl+Shift, change the option "del_tab_accelerator" value to "5". This number comes from ORing GDK_SHIFT_MASK and GDK_CONTROL_MASK.
39
40I realise that this configuration is not user-friendly, but... :-P
41
42Quick reference: Shift(1), Cps-Lock(2), Ctrl(4), Alt(8), Ctrl-S(5), Ctrl-A(12), Ctrl-A-S(13)
43
44### Keys
45
46To change default keys, set the key value you want to modify to your desired key. For example, if you want to use the "D" key instead of the "W" key to delete a tab, set "del_tab_key" to "D" in the config file.
47
48### Default keybindings
49
50 Ctrl + Shift + T -> New tab
51 Ctrl + Shift + W -> Close current tab
52 Ctrl + Shift + C -> Copy selected text
53 Ctrl + Shift + V -> Paste selected text
54 Ctrl + Shift + N -> Set tab name
55
56 Ctrl + Left cursor -> Previous tab
57 Ctrl + Right cursor -> Next tab
58 Ctrl + Shift + Left cursor -> Move tab to the left
59 Ctrl + Shift + Right cursor -> Move tab to the right
60 Ctrl + [1-9] -> Switch to tab N (1-9)
61
62 Ctrl + Shift + S -> Toggle/Untoggle scrollbar
63 Ctrl + Shift + Mouse left button -> Open link
64 F11 -> Fullscreen
65 Shift + PageUp -> Move up through scrollback by page
66 Shift + PageDown -> Move down through scrollback by page
67 Ctrl + Shift + Up -> Move up through scrollback by line
68 Ctrl + Shift + Down -> Move down through scrollback by line
69 Ctrl + Shift + [F1-F6] -> Select the colorset for the current tab
70
71You can also increase and decrease the font size in the GTK standard way:
72
73 Ctrl + '+' -> Increase font size
74 Ctrl + '-' -> Decrease font size
75
76By default, mouse buttons are bound to the following:
77
78 Button1 -> No action
79 Button2 -> Paste
80 Button3 -> Context menu
81
82Behavior can be changed with the following config settings:
83
84 copy_on_select -> set to true to automatically copy selected text
85 paste_button -> set to desired mouse button (default: 2)
86 menu_button -> set to desired mouse button (default: 3)
87
88## Contributing
89Pull requests are welcome. But please, create first a bug report in [Launchpad](https://bugs.launchpad.net/sakura), particularly if you plan to make major changes, to make sure your patch will be merged into **sakura**. If you'd like to contribute with translations, use the translations framework in [Launchpad](https://translations.launchpad.net/sakura) or send [me](mailto:dabisu@gmail.com) directly the translated po file.
90
91## License
92[GPL 2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
93
94\
95Enjoy **sakura**!
96