  bitedit bit editor
  Andrew McGill, andrew at ledge dot co.za
  Document revision 0.1, 8 September 2001

  bitedit is a simple ncurses program for editing a file.  It allows
  direct editing of the individual bits in a graphical fashion.  This is
  useful for directly editing existing bitmap font files, such as linux
  psf and psfu font files.
  ______________________________________________________________________

  Table of Contents


  1. Introduction

  2. Compiling

  3. Invoking

  4. Keys

     4.1 Movement keys
     4.2 Editing keys
     4.3 Saving and stuff


  ______________________________________________________________________

  11..  IInnttrroodduuccttiioonn

  bitedit is a ncurses program for editing a file.  It allows direct
  editing of the individual bits in a graphical fashion.  This is useful
  for editing existing bitmap font files, such as linux psf and psfu
  font files.

  bitedit is a rather simple program (at the moment).  It does not
  attempt to interpret the data it is displaying, beyond showing the
  bits on the screen graphically.


  22..  CCoommppiilliinngg

  If make doesn't do it for you, and you are really excited about this
  program, send your problem report to me, or, even better, a patch.


  33..  IInnvvookkiinngg

  To run the program, you need a file containing the data you want to
  edit.  Although the program works perfectly well in an X terminal, the
  testing of your bitmap is not as satisfying outside of the linux
  console environment:


       cp /usr/lib/kbd/consolefonts/fonttoedit.psfu.gz .
       gunzip fonttoedit.psfu.gz
       ./bitedit fonttoedit.psfu
       setfont fonttoedit.psfu








  44..  KKeeyyss

  The keys you use for editing and movement are similar to the vi
  keystrokes:


  44..11..  MMoovveemmeenntt kkeeyyss

  These are the keys to move the cursor in the editing area, and change
  the format of the display.

  +o  1, 2, 3, 4 - set the width of the display (ie. one, two, three or
     four bytes on a line)

  +o  h - move left

  +o  j - move down

  +o  k - move up

  +o  l - move right

  +o  PgUp, b - Move a page towards the top of the file

  +o  PgDn, n, Ctrl+D - Move a page towards the end of the file

  +o  < - Scroll the viewing window left by 1 byte without changing the
     cursor position

  +o  > - Scroll the viewing window right by 1 byte without changing the
     cursor position

  +o  Ctrl+L - Redraw the display (if corrupted by the output of a
     program)


  44..22..  EEddiittiinngg kkeeyyss

  These are the keys that make changes to the data in memory.

  +o  H - move left, changing current bit

  +o  J - move down, changing current bit

  +o  K - move up, changing current bit

  +o  L - move right, changing current bit

  +o  Space - flip current bit

  +o  Enter - Set current bit

  +o  Backspace - Clear current bit

     There is (currently) no undo function.


  44..33..  SSaavviinngg aanndd ssttuuffff

  The keys to manage the file are:

  +o  w - write file to disk.  You cannot change the name of the file --
     it is always the file name invoked from the command line.

  +o  t - test bitmap ... this is hard-coded to run /usr/bin/setfont for
     the file you are editing.
  +o  q - try to quit :)

































































