README

   1 FBPAD
   2 =====
   3
   4 Fbpad is a small and simple linux framebuffer virtual terminal.
   5 It manages many terminals through single-letter tags; each tag can
   6 hold two terminals.  The following table indicates fbpad's key-bindings
   7 (m-k means pressing k, 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 c-m-q           quit fbpad
  23 ==============  =======================================
  24
  25 SETTING UP
  26 ==========
  27
  28 You can edit config.h to configure fbpad.  To get fbpad running you need
  29 to make sure TINYFONT points to a valid tinyfont file and SHELL is the
  30 shell you want to execute.  Also the type of fbval_t should match
  31 the framebuffer depth: unsigned char for 8-bit, short for 16-bit and int
  32 for 24/32-bit framebuffers.  Once these are set, you should be able to
  33 start fbpad without problems.
  34
  35 Next you may want to change the list of fbpad tags by changing TAGS.
  36 The background and foreground colors can be changed using FGCOLOR and
  37 BGCOLOR macros, for instance the FGCOLOR of 2 and BGCOLOR of 0 creates
  38 green on black terminals.  Individual colors can be customized by
  39 editing the hex RGB color description of COLOR* macros.  Also SCRSHOT
  40 macro specifies text screenshot location.
  41
  42 If you are using the scrsnap branch, you can edit TAGS_SAVED to edit
  43 the list of saved terminals.  Framebuffer memory is saved and reloaded
  44 for these tags, which is very convenient when you are using programs
  45 that change the framebuffer simultaneously, like fbpdf.