fbpad: remove changing fontsets support
[fbpad.git] / README
blob4750d2bec82c9199d99807bc8afa6b35eccfecf5
1 FBPAD
2 =====
4 Fbpad is a small linux framebuffer virtual terminal.  It manages many
5 terminals through single-letter tags; each tag can hold two terminals.
6 The following table indicates fbpad's key-bindings (m-k means pressing k,
7 while holding the alt key).
9 ==============  =======================================
10 key             command
11 ==============  =======================================
12 m-c             execute a shell (SHELL)
13 m-m             execute mail program (MAIL)
14 m-e             execute editor program (EDITOR)
15 m-x             switch to tag 'x' (TAGS)
16 m-j             switch to alt terminal in this tag
17 m-k             like m-j
18 m-p             show tag summary
19 m-o             jump to last tag
20 m-tab           show next terminal
21 m-s             create a text screenshot (SCRSHOT)
22 m-y             redraw terminal
23 c-m-q           quit fbpad
24 ==============  =======================================
26 SETTING UP
27 ==========
29 To configure fbpad, you should edit config.h.  To get fbpad running
30 you need to make sure F0 points to a valid tinyfont file and SHELL to
31 the shell you want fbpad to execute.  Also the type of fbval_t should
32 match the framebuffer depth: unsigned char for 8-bit, short for 16-bit
33 and int for 24/32-bit framebuffers.  Once these are set, you should be
34 able to start fbpad without problems.
36 Fbpad uses tinyfont files, which can be created using ft2tf program
37 (http://litcave.rudi.ir/).  The FR, FI and FB macros specify the path
38 of the tinyfont files for regular, italic and bold fonts.  If FI or FB
39 is NULL, the regular font is used for italic or bold text.
41 Next you may want to change the list of fbpad tags by changing TAGS.
42 FGCOLOR and BGCOLOR macros specify foreground and background colors,
43 for instance the FGCOLOR of 2 and BGCOLOR of 0 creates green on black
44 terminals.  Individual colors can be customized by editing the hex RGB
45 color description of COLOR* macros.  Also SCRSHOT macro specifies where
46 fbpad text screenshots, as created using "m-s" command, should be saved.
48 If you are want to use fbpad's scrsnap feature, you can edit TAGS_SAVED
49 to change the list of saved terminals.  Framebuffer memory is saved and
50 reloaded for these tags, which is very convenient when you are using
51 programs that change the framebuffer simultaneously, like fbpdf.