README.txt		    www.fege.net		      2026-07-19
		 _____    _____     ____    _____
		|  ___|\ |  ___|\  / ___\  |  ___|\ U
		| |\__\| | |\__\| | /\__\\ | |\__\| N
		|  _|\   |  _|\   | |/_ \  |  _|\   I
		| |\_\   | |\_\   | |_/ |\ | |\_\   X
		|_||     |_____|\  \____/| |_____|\ * N E T
		 \_\      \____\|   \___\/  \____\|

Welcome to the LMB interactive line mode browser for teletypes!
________________________________________________________________________
Provides modern browsing compatibility for legacy teletype hardware up
to modern handheld devices -- distraction free!

TABLE OF CONTENTS:
  1. Contents
  2. Description & system requirements
  3. How to start
  4. Documentation
  5. Copyright & Contact

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

1.: CONTENTS: WHAT IS PROVIDED WITH THIS PACKAGE?

    beyond this README.txt

    1. lmb.sh browsing shell script for POSIX shell sh(1).

    2. DOCUMENTATION:  User manuals of the program as PDF or
		       ROFF source code:
       - lmb.1       - mdoc manual page of lmb.sh.
       - lmb.pdf     - PDF version of the manual page of lmb.sh.

    3. LICENSE agreement (gpl-2.0.txt) and a Makefile to install the
       collection on the target system or remove it from there.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

2.: DESCRIPTION and SYSTEM REQUIREMENTS:

    The provided program of this package is a shell scripts ready to run
    immediately on POSIX compatible systems, if additional software
    stated below is installed and available on the target system.
    If desired, this suite can be installed on the system permanently by
    running the Makefile as root with make(1) as described below.  The
    same is true for uninstalling the collection.

    One of the following packages need to be installed in order for
    "lmb.sh" to work properly:

       For browsers as the underlying rendering engine: either
          - "lynx" (preferred),
          - "elinks",
          - "w3m" or
          - "links".

       For additional picture rendering, optionally
          - "jp2a" and
          - "ImageMagick".

       For additional PDF rendering, optionally
          - "pdftotext" or
          - "ps2ascii".

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

3.: HOW TO START:

    1. Accept the license agreement "gpl-2.0.txt" (or delete this
       package fully otherwise).

    2. Familiarise yourself with the programs and concepts by studying
       the manuals.
       
    3. Install a text mode browser, either "lynx", "elinks", "w3m" or
       "links" on your system and make them available for "lmb.sh" to be
       executed.  "lmb.sh" needs either of them to render the webpages
       in order to work, because it uses them as the underlying browser
       engine.
       Besides that, to be able to render pictures, "jp2a" and
       "ImageMagick" should be installed, but is not mandatory.
       In order to render PDF, either "pdftotext" or "ps2ascii" is
       needed.

    4. Make sure the program is flagged as executable by running

	$ chmod a+x *.sh

       If desired, install the collection on the target system by
       running the Makefile as root with make(1) as follows:

	# make install clean

       Uninstalling could be achieved by running the Makefile as root
       again:

	# make uninstall


- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

4.: DOCUMENTATION:

    For reference documentation of the program refer to the manual.
    This manual is provided in two forms:  As
      - PDF file and
      - ROFF-style manual page.  It can be viewed within the terminal
	with man(1) in the following manner:

	$ man ./lmb.1

    The program includes also a builtin help about how to operate it.
    This short help can be printed out by running for example

	$ ./lmb.sh -h

    When used interactively, help can be printed out by pressing '?' and
    'ENTER'.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

5.: COPYRIGHT & CONTACT:

    Copyright (C) 2026, Marc Fege.
    Internet:	https://www.fege.net/software
    E-Mail:	13mdf@fege.net

    Please refer to "gpl-2.0.txt" for details.

________________________________________________________________________

Have much fun with this software package!

Sincerely,
your Marc Fege
alias 13MDF / DN9MF.
