README

   1 FBPAD
   2 =====
   3
   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).
   8
   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 m-f x           use font x in this terminal
  25 ==============  =======================================
  26
  27 SETTING UP
  28 ==========
  29
  30 To configure fbpad, you should edit config.h.  To get fbpad running
  31 you need to make sure F0 points to a valid tinyfont file and SHELL to
  32 the shell you want fbpad to execute.  Also the type of fbval_t should
  33 match the framebuffer depth: unsigned char for 8-bit, short for 16-bit
  34 and int for 24/32-bit framebuffers.  Once these are set, you should be
  35 able to start fbpad without problems.
  36
  37 Fbpad uses tinyfont files which can be created using ft2tf program
  38 (http://litcave.rudi.ir/).  At any moment each terminal in fbpad uses
  39 a fontset; i.e. a set of three, not necessarily different, fonts for
  40 rendering regular, italic, and bold text.  Fx macros specify the fonts in
  41 each fontset where the digit x is the identifier of the fontset ("m-f x"
  42 command modifies current terminal to use fontset x).
  43
  44 Next you may want to change the list of fbpad tags by changing TAGS.
  45 FGCOLOR and BGCOLOR macros specify foreground and background colors,
  46 for instance the FGCOLOR of 2 and BGCOLOR of 0 creates green on black
  47 terminals.  Individual colors can be customized by editing the hex RGB
  48 color description of COLOR* macros.  Also SCRSHOT macro specifies where
  49 fbpad text screenshots, as created using "m-s" command, should be saved.
  50
  51 If you are want to use fbpad's scrsnap feature, you can edit TAGS_SAVED
  52 to change the list of saved terminals.  Framebuffer memory is saved and
  53 reloaded for these tags, which is very convenient when you are using
  54 programs that change the framebuffer simultaneously, like fbpdf.