- Revise text, and fix typos and grammatical errors.

- Add syscons.4.

If there still are errors, whether technical or grammatical, they are
entirely mine, not the reviewers'.

Reviewed by: sos, jkh, archie, Nick Hilliard <nick@iol.ie>

1 files changed, 66 insertions, 59 deletions

diff --git a/share/man/man4/splash.4 b/share/man/man4/splash.4
index 1c9b9a2..1791966 100644
--- a/share/man/man4/splash.4
+++ b/share/man/man4/splash.4
@@ -24,9 +24,9 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $Id: $
+.\" $Id: splash.4,v 1.1 1999/02/07 05:40:14 yokota Exp $
 .\"
-.Dd February 6, 1999
+.Dd February 9, 1999
 .Dt SPLASH 4 i386
 .Os FreeBSD
 .Sh NAME
@@ -44,80 +44,78 @@ This driver is required if the splash bitmap image is to be loaded or
 any screen saver is to be used.
 .Sh SPLASH SCREEN
 You can load and display an arbitrary bitmap image file as welcome banner
-on the screen when the system is about to start.
-It stays on the screen while the system is being initialized,
-and goes away when you hit any key (this may not work
-immediately if the kernel is still probing devices), 
-when a screen saver is loaded and initialized,
-or when the "Login" prompt first appears on the screen.
+on the screen when the system is about to start.  This image will remain on
+the screen during kernel initialization process until the ``Login'' prompt
+appears on the screen or until a screen saver is loaded and initialized. 
+The image will also disappear if you hit any key, although this may not work
+immediately if the kernel is still probing devices.
 .Pp
 If you specify 
 .Fl c
 or
 .Fl v
-boot option when loading kernel, the splash image won't appear
-(though is still loaded and can be used as a screen saver later; see below).
+boot option when loading kernel, the splash image will not appear. However, it
+is still loaded and can be used as a screen saver later: see below.
 .Pp
-In order to display the bitmap, the bitmap file itself and
-matching splash image decoder must be loaded by the boot loader.
+In order to display the bitmap, the bitmap file itself and the
+matching splash image decoder module must be loaded by the boot loader.
 Currently the following decoder module is available:
 .Pp
-.Bl -tag -width splash -compact
-.It splash_bmp.ko
+.Bl -tag -width splash_decoder -compact
+.It Pa splash_bmp.ko
 W*ndows BMP file decoder.
-While the BMP file format allows various depth of colors, this decoder
-can only handle 256 color bitmaps.
-Other color depth won't work.
+While the BMP file format allows images of various color depths, this
+decoder currently only handles 256 color bitmaps.  Bitmaps of other color
+depths will not be displayed.
 .El
 .Pp
 The
 .Sx EXAMPLES
 section illustrates how to set up the splash screen.
 .Pp
-The size of the bitmap must be 320x200 or less,
-if the standard VGA video mode is used. 
+If the standard VGA video mode is used,
+the size of the bitmap must be 320x200 or less.
 If you enable the VESA mode support in the kernel,
 either by statically linking the VESA module or by loading the VESA module
 .Pq see Xr vga 4 ,
-you can load as large bitmap as 1024x768, depending on the VESA BIOS
-and the amount of video memory on the video card.
+you can load bitmaps up to a resolution of 1024x768, depending on the VESA
+BIOS and the amount of video memory on the video card.
 .Sh SCREEN SAVER
-The screen saver will pop up 
-when the system is considered "idle", that is, the user has not typed 
-a key or moved the mouse, for the specified duration.
-As the screen saver is an optional module, it must be explicitly loaded
-to the memory.
-Currently the following screen saver modules are available:
-.Pp
-.Bl -tag -width splash -compact
-.It blank_saver.ko
+The screen saver will activate when the system is considered idle: i.e.
+when the user has not typed a key or moved the mouse for a specified period
+of time.  As the screen saver is an optional module, it must be explicitly
+loaded into memory. Currently the following screen saver modules are
+available:
+.Pp
+.Bl -tag -width splash_module.ko -compact
+.It Pa blank_saver.ko
 This screen saver simply blanks the screen.
-.It daemon_saver.ko
+.It Pa daemon_saver.ko
 Animated BSD Daemon screen saver.
-.It fade_saver.ko
+.It Pa fade_saver.ko
 The screen will gradually fade away.
-.It green_saver.ko
+.It Pa green_saver.ko
 If the monitor supports power saving mode, it will be turned off.
-.It logo_saver.ko
+.It Pa logo_saver.ko
 Animated graphical BSD Daemon.
-.It rain_saver.ko
+.It Pa rain_saver.ko
 Draws shower on the screen.
-.It snake_saver.ko
+.It Pa snake_saver.ko
 Draws a snake of string.
-.It star_saver.ko
+.It Pa star_saver.ko
 Twinkling stars.
-.It warp_saver.ko
+.It Pa warp_saver.ko
 Streaking stars.
 .El
 .Pp
-Load a screen saver module via
-.Xr kldload 1 .
+Screen saver modules can be loaded using 
+.Xr kldload 1 :
 .Pp
 .Dl kldload logo_saver
 .Pp
-Then specify timeout value, in seconds, as follows:
+The timeout value in seconds can be specified as follows:
 .Pp
-.Dl vidcontrol -t timeout
+.Dl vidcontrol -t N
 .Pp
 Alternatively, you can set the
 .Ar saver
@@ -131,28 +129,25 @@ and the timeout value is set when the system starts.
 .Pp
 The screen saver may be instantly activated by hitting the
 .Ar saver
-key (Shift-Pause on the AT enhanced keyboard, Shift-Ctrl-NumLock/Pause
-on the AT 84 keyboard by default).
-You can change the
+key: the defaults are 
+.Em Shift-Pause
+ on the AT enhanced keyboard and
+.Em Shift-Ctrl-NumLock/Pause
+on the AT 84 keyboard. You can change the
 .Ar saver
-key by modifying the keymap.
-See
-.Xr kbdcontrol 1
-and 
-.Xr keymap 5 ,
+key by modifying the keymap
+.Pq see Xr kbdcontrol 1 , Xr keymap 5 ,
 and assign the
 .Ar saver
 function to a key of your preference.
 .Pp
-The screen saver won't run if the current screen is not in the
-text mode.
+The screen saver will not run if the screen is not in text mode.
 .Sh SPLASH SCREEN AS A SCREEN SAVER
-If you load a splash image but don't load a screen saver, 
+If you load a splash image but do not load a screen saver, 
 you can continue using the splash module as a screen saver.
-Specify the screen blanking interval as explained in the
+The screen blanking interval can be specified as described in the
 .Sx SCREEN SAVER
-section above, and
-the splash screen image will come back after the specified time.
+section above.
 .\".Sh DRIVER CONFIGURATION
 .Sh FILES
 .Bl -tag -width /modules/splash_xxxx.ko -compact
@@ -168,6 +163,11 @@ screen saver modules
 the VESA support module
 .El
 .Sh EXAMPLE
+In order to load the splash screen or the screen saver, you must 
+have the following line in the kernel configuration file.
+.Pp
+.Dl pseudo-device splash
+.Pp
 The following examples show how to load the splash screen image from
 the boot loader prompt.
 They may be typed by hand at the loader prompt or may be written in
@@ -193,7 +193,7 @@ The third line loads the splash image decoder module
 .Pp
 In the following example, the VESA module
 is loaded so that a bitmap file which cannot be displayed in standard
-VGA modes may be shown using one of VESA video modes.
+VGA modes may be shown using one of the VESA video modes.
 .Bd -literal -offset indent
 load kernel
 load vesa
@@ -213,10 +213,11 @@ only.  They are not available for the alternative console driver
 .Xr pcvt 4 .
 .Sh BUGS
 If you load a screen saver while another screen saver has already
-been loaded, the first screen saver won't be automatically unloaded
-and remain in memory, wasting kernel memory space.
+been loaded, the first screen saver will not be automatically unloaded
+and will remain in memory, wasting kernel memory space.
 .Sh SEE ALSO
 .Xr vidcontrol 1 ,
+.Xr syscons 4 ,
 .Xr vga 4 ,
 .Xr rc.conf 5 ,
 .Xr kldload 8 ,
@@ -231,3 +232,9 @@ The
 .Nm
 driver and this manual page were written by
 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
+The
+.Pa splash_bmp
+module was written by
+.An Michael Smith Aq msmith@FreeBSD.org
+and
+.An Kazutaka Yokota .