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