summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL81
1 files changed, 81 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..060b20c
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,81 @@
+Installing sakura
+===============
+
+* How to compile and install this beast ?
+
+ $ cmake .
+ $ make
+ $ su -c 'make install'
+
+ sakura now uses the CMake building system (RIP our old system MOBS, we'll remember you ;)).
+
+ To install sakura with a different prefix, cmake needs to be invoked with the proper environment
+ variables, so to install sakura in /usr, you must type:
+
+ $ cmake -DCMAKE_INSTALL_PREFIX=/usr .
+
+ Use CMAKE_BUILD_TYPE=Debug if you need debug symbols. Default type is "Release".
+
+
+Keybindings support
+===================
+
+ sakura supports keyboard bindings in its config file (~/.config/sakura/sakura.conf), but there's
+ no GUI to edit them, so plese use your favourite editor to change the following properties:
+
+ Accelerators:
+
+ Accelerators can be set to any mask value from the GdkModifierType in gdktypes.h. For reference look at:
+ https://github.com/GNOME/gtk/blob/master/gdk/gdktypes.h
+
+ Quick reference: Shift(1), Cps-Lock(2), Ctrl(4), Alt(8), Ctrl-S (5), Ctrl-A(12), Ctrl-A-S(13)
+
+ Mask values can be combined by ORing them. For example, to set the delete tab accelerator to Ctrl+Shift,
+ set "del_tab_accelerator=5". GDK_SHIFT_MASK has a value of 1 (1 << 0), and GDK_CONTROL_MASK has a value of
+ 4 (1 << 2), so ORing them and you got 5 for Ctrl+Shift.
+
+ I realise that this configuration is not user-friendly, but :)
+
+ Keys:
+
+ For example, to set the add tab key to 'T':
+ add_tab_key=T
+
+
+ Defaults:
+
+ Ctrl + Shift + T -> New tab
+ Ctrl + Shift + W -> Close current tab
+ Ctrl + Shift + C -> Copy selected text
+ Ctrl + Shift + V -> Paste selected text
+ Ctrl + Shift + N -> Set tab name
+
+ Ctr + Left cursor -> Previous tab
+ Ctr + Right cursor -> Next tab
+ Ctr + Shift + Left cursor -> Move tab to the left
+ Ctr + Shift + Right cursor -> Move tab to the right
+ Ctrl + [1-9] -> Switch to tab N (1-9)
+
+ Ctrl + Shift + S -> Toggle/Untoggle scrollbar
+ Ctrl + Shift + Mouse left button -> Open link
+ F11 -> Fullscreen
+ Shift + PageUp -> Move up through scrollback by page
+ Shift + PageDown -> Move down through scrollback by page
+ Ctrl + Shift + Up -> Move up through scrollback by line
+ Ctrl + Shift + Down -> Move down through scrollback by line
+ Ctrl + Shift + [F1-F6] -> Select the colorset for the current tab
+
+ You can also increase and decrease the font size in the GTK+
+ standard way (not configurable):
+
+ Ctrl + '+' -> Increase font size
+ Ctrl + '-' -> Decrease font size
+
+
+
+--
+
+Enjoy sakura!
+
+
+