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
   7 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 current tag's alternative terminal
  17 m-k             like m-j
  18 m-p             show tag summary
  19 m-o             jump to the previous tag
  20 m-tab           show the next terminal
  21 m-s             create a text screenshot (SCRSHOT)
  22 m-y             redraw the terminal
  23 c-m-l           lock the screen; use PASS to unlock
  24 c-m-o           disable/enable tag switching
  25 c-m-q           quit fbpad
  26 m-,             scroll up
  27 m-.             scroll down
  28 ==============  =======================================
  29
  30 Fbpad can be instructed to execute a single program: the program and
  31 its arguments should be passed as command line arguments of fbpad.
  32 Fbpad executes the specified program in a terminal, disables all
  33 terminal switching commands, and exits as soon as the program
  34 finishes.
  35
  36
  37 SETTING UP
  38 ==========
  39
  40 To configure fbpad, you should edit conf.h.  To get fbpad running
  41 you need to make sure FR points to a valid fbpad font (for testing
  42 you can try http://litcave.rudi.ir/courr.tf) and SHELL to the shell
  43 you want fbpad to execute.  Also the type of fbval_t should match the
  44 framebuffer depth: unsigned char for 8-bit, short for 16-bit and int
  45 for 24/32-bit framebuffers.  Once these are set, you should be able to
  46 start fbpad without problems.
  47
  48 Fbpad fonts can be generated using fbpad_mkfn program
  49 (http://litcave.rudi.ir/).  The FR, FI, and FB macros specify the path
  50 of fbpad fonts for regular, italic, and bold fonts.  If FI or FB is
  51 NULL, the regular font is used for italic or bold text.
  52
  53 Next, you may want to change the list of fbpad tags by changing TAGS.
  54 FGCOLOR and BGCOLOR macros specify foreground and background colors,
  55 for instance the FGCOLOR of 2 and BGCOLOR of 0 creates green on black
  56 terminals.  Individual colors can be customized by editing the hex RGB
  57 color description of COLOR* macros.  Also SCRSHOT macro specifies where
  58 fbpad text screenshots, created by "m-s" command, should be saved.
  59
  60 If you want to use fbpad's scrsnap feature, you can edit TAGS_SAVED to
  61 change the list of saved terminals.  Framebuffer memory is saved and
  62 reloaded for these tags, which is very convenient when you are using
  63 programs that change the framebuffer simultaneously, like fbpdf.
  64
  65
  66 256-COLOR MODE
  67 ==============
  68
  69 Fbpad supports xterm's 256-color extension, but most programs will not
  70 use this extension, unless the $TERM terminfo entry declares this
  71 feature.  For this purpose, fbpad-256 terminfo file can be created to
  72 contain (the two-space identation should be ignored):
  73
  74   fbpad-256,
  75         use=linux, U8#0,
  76         colors#256,
  77         pairs#32767,
  78         setab=\E[%?%p1%{8}%<%t4%p1%d%e%p1%{16}%<%t10%p1%{8}%-%d%e48;5;%p1%d%;m,
  79         setaf=\E[%?%p1%{8}%<%t3%p1%d%e%p1%{16}%<%t9%p1%{8}%-%d%e38;5;%p1%d%;m,
  80
  81 Which can be installed with tic command:
  82
  83   $ tic -x ./fbpad-256
  84
  85 The following line should be added to shell's startup script:
  86
  87   export TERM=fbpad-256
  88
  89 Note that in order to use this feature and italic fonts in Vim, adding
  90 fbpad-256 terminfo is not necessary.  Including the following lines in
  91 the vimrc file should enable them:
  92
  93   set t_ZH=\e[3m
  94   set t_Co=256