fbgetty Copyright (C) 1999,2000,2001 Yann Droneaud (yann.droneaud@iupmime.univ-lemans.fr). 

This file describe fbgetty version 0.1.5

Description
-----------

fbgetty a new getty program who support fully possibility of the 
Linux console. For the moment it run only under Linux.

Features
--------
  extended issue display (escape codes, shell variables)
  framebuffer support (display logo)
  refresh issue when VT is activated (time, user, uptime)
  display date/time according to locale
  display the output of any program
  include many files in issue

Usage 
-----

fbgetty [options] [variables] tty_device [framebuffer_device]

Options:

  -t --tty=               set tty device 
  -f --fb= --framebuffer= set framebuffer device
  -i --issue=             set issue file
  -l --login-program=     set login program
  -p --login-prompt=      set login prompt
  -o --login-timeout=     set login timeout
     --clear-screen[=(yes|no|0|1)]
                          clear or not the screen, default is yes
     --kbd=[+|-](num|caps) 
                          set or unset a keyboard flags
     --version            show version
     --dump-config        display the current configuration
     --help               show help


Options
-------

  --issue=none             disable display of issue file
  --login-prompt=none      disable display of login prompt

  --kbd=+num,-caps	   enable numpad, disable capslock

  --keyboard=numlock --kbd=-capslock    likewise (if - nor + is present set the flag)
                 

Environment
-----------
  fbgetty recognizes these environment variables
  simply put them on the command line

  LANG=[locale]
  issue=
  framebuffer=
  tty=
  login_program=
  login_prompt=
  login_timeout=
  refresh=
  clear_screen=

Difference between arguments, options and variables
---------------------------------------------------
 priority:
    options
    variables
    arguments

 if you put "fbgetty /dev/tty0 fb0 -t tty1 framebuffer=fb1"
  fbgetty will use tty1 and framebuffer fb1
 
Issue tag
---------

@system        %s display OS name (will certainly be Linux)

@version
@release       %r display OS release

@architecture
@arch          %m display host architecture

@tty
@line
@vt            %l display tty

@framebuffer
@fb            %f display framebuffer

@hostname      %n display hostname

@domain        %o display domain

@FQDN          -  *

@user          %u display number of users connected
@Users         %U display number of users with format  %d user(s)

@loadavg       -  display load average *

@date          %d display date  

@time          %t display time (24H)

@uptime         - *

@include=       - include other file to be parsed.
		  syntax:
		  @include=file[,files...]

@image          - * not yet supported


$...              display env variable ($TERM will echoing linux or linux-m)

`program [args...]`
                  run the specified program with args
		  NOTE: the old syntax &program is not supported since fbgetty-0.1.5test


\a                echo alert (bell)
\b                backspace
\e
\E                echo escape char
\f                echo formfeed
\n                echo new line
\r                echo carriage return
\t                echo horizontal tab
\v                echo vertical tab
\@                echo arobas
\%                echo percent char
\&                echo ampersand
\$                echo dollar sign
\ooo              echo character octal *
\xhh
\Xhh              echo hex character *
\ 		  don't print the carriage return (used to break a long line)

All the short escape (\? or %u) work in login prompt

Issue files
-----------
If not overrided by --issue-file, fbgetty will look for /etc/issue
If LANG is set, it will first look for issue-file.[LANG]
If not, it will print the default

Installation
------------

$ ./configure.default
$ make
$ su
# make install

examples and scripts are installed in the $datadir/fbgetty
by default /usr/share/fbgetty

Edit inittab
replace your old getty by fbgetty
see examples/*.*

More Information
----------------

see info pages
see man pages
see http://www.multimania.com/lch/projects/fbgetty