From coocoo@lilith.wh-wurm.uni-ulm.de  Wed Jul  2 05:09:51 2003
Return-Path: <coocoo@lilith.wh-wurm.uni-ulm.de>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id D66CE37B401
	for <FreeBSD-gnats-submit@freebsd.org>; Wed,  2 Jul 2003 05:09:51 -0700 (PDT)
Received: from lilith.wh-wurm.uni-ulm.de (lilith.wh-wurm.uni-ulm.de [134.60.106.64])
	by mx1.FreeBSD.org (Postfix) with ESMTP id D1FAD43FF3
	for <FreeBSD-gnats-submit@freebsd.org>; Wed,  2 Jul 2003 05:09:50 -0700 (PDT)
	(envelope-from coocoo@lilith.wh-wurm.uni-ulm.de)
Received: from lilith.wh-wurm.uni-ulm.de (localhost [127.0.0.1])
	by lilith.wh-wurm.uni-ulm.de (8.12.9/8.12.9) with ESMTP id h62C9kKO000813
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 2 Jul 2003 14:09:46 +0200 (CEST)
	(envelope-from coocoo@lilith.wh-wurm.uni-ulm.de)
Received: (from coocoo@localhost)
	by lilith.wh-wurm.uni-ulm.de (8.12.9/8.12.9/Submit) id h62C9iti000812;
	Wed, 2 Jul 2003 14:09:44 +0200 (CEST)
Message-Id: <200307021209.h62C9iti000812@lilith.wh-wurm.uni-ulm.de>
Date: Wed, 2 Jul 2003 14:09:44 +0200 (CEST)
From: Siegbert.Baude@lilith.wh-wurm.uni-ulm.de
Reply-To: Siegbert.Baude@gmx.de
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Clarify the location of the splash image in the splash man page
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         54009
>Category:       docs
>Synopsis:       [patch] clarify the location of the splash image in the splash(4) man page
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    trhodes
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Jul 02 05:10:18 PDT 2003
>Closed-Date:    Sun Oct 08 00:08:26 GMT 2006
>Last-Modified:  Sun Oct 08 00:08:26 GMT 2006
>Originator:     Siegbert Baude
>Release:        FreeBSD 5.1-CURRENT i386
>Organization:
Universitaet Ulm
>Environment:
System: FreeBSD lilith 5.1-CURRENT FreeBSD 5.1-CURRENT #6: Fri Jun 27 08:19:44 CEST 2003 toor@lilith:/usr/obj/usr/src/sys/LILITH i386


>Description:
The splash.4 man page is not clear, where the actual splash image should be
placed. After having read the man page, I thought it should go to /boot, when
in fact it should go to /boot/kernel.
I added this information to the man page.

>How-To-Repeat:
>Fix:
Apply the following patch to the man page splash.4:

--- splash.4    Wed Jul  2 13:46:42 2003
+++ splash.4.new        Wed Jul  2 13:48:22 2003
@@ -177,6 +177,8 @@
 screen saver modules
 .It Pa /boot/kernel/vesa.ko
 the VESA support module
+.It Pa /boot/kernel/splash.bmp
+the default splash image
 .El
 .Sh EXAMPLES
 In order to load the splash screen or the screen saver, you must
@@ -196,7 +198,7 @@
 .Ed
 .Pp
 In the above example, the file
-.Pa chuck.bmp
+.Pa /boot/kernel/chuck.bmp
 is loaded.
 In the following example, the VESA module
 is loaded so that a bitmap file which cannot be displayed in standard


>Release-Note:
>Audit-Trail:

From: Tom Rhodes <trhodes@FreeBSD.org>
To: Siegbert.Baude@gmx.de
Cc: Siegbert.Baude@lilith.wh-wurm.uni-ulm.de,
	FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/54009: Clarify the location of the splash image in the
 splash man page
Date: Wed, 2 Jul 2003 10:02:29 -0400

 On Wed, 2 Jul 2003 14:09:44 +0200 (CEST)
 Siegbert.Baude@lilith.wh-wurm.uni-ulm.de wrote:
 
 > >Description:
 > The splash.4 man page is not clear, where the actual splash image should be
 > placed. After having read the man page, I thought it should go to /boot, when
 > in fact it should go to /boot/kernel.
 > I added this information to the man page.
 
 I have my image in /boot.  Perhaps just changing it to read /boot
 where the image is shown?
 
 --
 Tom Rhodes

From: Siegbert Baude <siegbert.baude@gmx.de>
To: freebsd-gnats-submit@FreeBSD.org, msmith@FreeBSD.org
Cc: trhodes@FreeBSD.org
Subject: Re: docs/54009: Clarify the location of the splash image in the splash man page
Date: Thu, 3 Jul 2003 18:16:32 +0200

 Tom, but you have an absolute path to the image in your loader.conf, right?
 
 I checked the docu now once again, and every piece of it including the splash 
 mini-FAQ says, the splash image should go into /boot. I found the solution in 
 /boot/defaults/loader.conf, where it is said that the image must be located 
 somewhere in the module_path. The default for this however is 
 "/boot/kernel;/boot/modules/" so a splash image in /boot isn't found.
 
 I think there are two solutions:
 
 1) Add /boot to the module_path in /boot/defaults/loader.conf like
 "/boot/kernel;/boot/modules/;/boot"
 
 2) Remove all examples of images in the documentation, which use relative 
 paths and substitute the absolute paths.
 
 Mike, do you think there might be some problems with solution #1? It would be 
 easier to correct, but maybe #2 is the cleaner way. I would create the diffs 
 for the man pages and conf-files, so you only had to commit them.
 
 Ciao
 Siegbert
 

From: Michael Smith <msmith@freebsd.org>
To: Siegbert Baude <siegbert.baude@gmx.de>
Cc: freebsd-gnats-submit@freebsd.org, trhodes@freebsd.org
Subject: Re: docs/54009: Clarify the location of the splash image in the splash man page
Date: Thu, 3 Jul 2003 09:19:00 -0700

 --Apple-Mail-2--514954433
 Content-Transfer-Encoding: 7bit
 Content-Type: text/plain;
 	charset=US-ASCII;
 	format=flowed
 
 
 Don't screw with the module path.  Either fix the documentation to 
 reflect
 reality, or change the code to search for the splash elsewhere.
 
   = Mike
 
 On Thursday, July 3, 2003, at 9:16 AM, Siegbert Baude wrote:
 
 > Tom, but you have an absolute path to the image in your loader.conf, 
 > right?
 >
 > I checked the docu now once again, and every piece of it including the 
 > splash
 > mini-FAQ says, the splash image should go into /boot. I found the 
 > solution in
 > /boot/defaults/loader.conf, where it is said that the image must be 
 > located
 > somewhere in the module_path. The default for this however is
 > "/boot/kernel;/boot/modules/" so a splash image in /boot isn't found.
 >
 > I think there are two solutions:
 >
 > 1) Add /boot to the module_path in /boot/defaults/loader.conf like
 > "/boot/kernel;/boot/modules/;/boot"
 >
 > 2) Remove all examples of images in the documentation, which use 
 > relative
 > paths and substitute the absolute paths.
 >
 > Mike, do you think there might be some problems with solution #1? It 
 > would be
 > easier to correct, but maybe #2 is the cleaner way. I would create the 
 > diffs
 > for the man pages and conf-files, so you only had to commit them.
 >
 > Ciao
 > Siegbert
 >
 >
 >
 --
 Where am I, and what am I doing in this handbasket?
 
 --Apple-Mail-2--514954433
 Content-Transfer-Encoding: 7bit
 Content-Type: text/enriched;
 	charset=US-ASCII
 
 
 
 Don't screw with the module path.  Either fix the documentation to
 reflect
 
 reality, or change the code to search for the splash elsewhere.
 
 
  = Mike
 
 
 On Thursday, July 3, 2003, at 9:16 AM, Siegbert Baude wrote:
 
 
 <excerpt>Tom, but you have an absolute path to the image in your
 loader.conf, right?
 
 
 I checked the docu now once again, and every piece of it including the
 splash 
 
 mini-FAQ says, the splash image should go into /boot. I found the
 solution in 
 
 /boot/defaults/loader.conf, where it is said that the image must be
 located 
 
 somewhere in the module_path. The default for this however is 
 
 "/boot/kernel;/boot/modules/" so a splash image in /boot isn't found.
 
 
 I think there are two solutions:
 
 
 1) Add /boot to the module_path in /boot/defaults/loader.conf like
 
 "/boot/kernel;/boot/modules/;/boot"
 
 
 2) Remove all examples of images in the documentation, which use
 relative 
 
 paths and substitute the absolute paths.
 
 
 Mike, do you think there might be some problems with solution #1? It
 would be 
 
 easier to correct, but maybe #2 is the cleaner way. I would create the
 diffs 
 
 for the man pages and conf-files, so you only had to commit them.
 
 
 Ciao
 
 Siegbert
 
 
 
 
 </excerpt><italic><fontfamily><param>Arial Narrow</param>--
 
 Where am I, and what am I doing in this handbasket?</fontfamily></italic>
 
 
 --Apple-Mail-2--514954433--
 

From: Tom Rhodes <trhodes@FreeBSD.org>
To: Michael Smith <msmith@FreeBSD.org>
Cc: siegbert.baude@gmx.de, freebsd-gnats-submit@FreeBSD.org
Subject: Re: docs/54009: Clarify the location of the splash image in the
 splash man page
Date: Thu, 3 Jul 2003 12:10:18 -0400

 From the loader.conf(5) manual page:
 
 bitmap_load
                      (``NO'') If set to ``YES'', a bitmap will be loaded to be
                      displayed on screen while booting.
 
 bitmap_name
                      (``/boot/splash.bmp'') Name of the bitmap to be loaded.
                      Any other name can be used.
 
 I think that is quite explicit on using splash images.  If we read down
 a little further, we come across:
 
 FILES
      /boot/defaults/loader.conf  default settings -- do not change this file.
      /boot/loader.4th            defines the commands used by loader to read
                                  and process loader.conf.
      /boot/loader.conf           user defined settings.
      /boot/loader.conf.local     machine-specific settings for sites with a
                                  common loader.conf.
      /boot/loader.rc             contains the instructions to automatically
                                  process loader.conf.
 
 The one I'm interested in is /boot/loader.conf which is described as 'user defined
 settings.', which I think is self explainatory.  Now, loader.conf works similar
 to rc.conf and a few other files in FreeBSD where the user defined settings
 should exist in another file which overrides the default.  My personal feeling
 here is that the proper method would be to:
 
 Create the /boot/loader.conf file if it does not exist.  Put in the custom
 splash information with what is defined above.  That is how I did it on my
 system.  Now, if you do not define a splash image, then yes I'm sure it
 would look in the module path (without looking at the code nor any other
 manual page/documentation besides loader.conf(5)).  Try my suggestion
 above and let me know if that fixes your problem.  Thanks.
 
 --
 Tom Rhodes
 
 
 On Thu, 3 Jul 2003 09:19:00 -0700
 Michael Smith <msmith@freebsd.org> wrote:
 
 > 
 > Don't screw with the module path.  Either fix the documentation to 
 > reflect
 > reality, or change the code to search for the splash elsewhere.
 > 
 >   = Mike
 > 
 > On Thursday, July 3, 2003, at 9:16 AM, Siegbert Baude wrote:
 > 
 > > Tom, but you have an absolute path to the image in your loader.conf, 
 > > right?
 > >
 > > I checked the docu now once again, and every piece of it including the 
 > > splash
 > > mini-FAQ says, the splash image should go into /boot. I found the 
 > > solution in
 > > /boot/defaults/loader.conf, where it is said that the image must be 
 > > located
 > > somewhere in the module_path. The default for this however is
 > > "/boot/kernel;/boot/modules/" so a splash image in /boot isn't found.
 > >
 > > I think there are two solutions:
 > >
 > > 1) Add /boot to the module_path in /boot/defaults/loader.conf like
 > > "/boot/kernel;/boot/modules/;/boot"
 > >
 > > 2) Remove all examples of images in the documentation, which use 
 > > relative
 > > paths and substitute the absolute paths.
 > >
 > > Mike, do you think there might be some problems with solution #1? It 
 > > would be
 > > easier to correct, but maybe #2 is the cleaner way. I would create the 
 > > diffs
 > > for the man pages and conf-files, so you only had to commit them.
 > >
 > > Ciao
 > > Siegbert
 > >
 > >
 > >
 > --
 > Where am I, and what am I doing in this handbasket?
 > 

From: Siegbert Baude <Siegbert.Baude@gmx.de>
To: freebsd-gnats-submit@freebsd.org
Cc: Tom Rhodes <trhodes@freebsd.org>,
	Michael Smith <msmith@freebsd.org>
Subject: Re: docs/54009: Clarify the location of the splash image in the splash
 man page
Date: Sun, 06 Jul 2003 20:56:47 +0200

 > Create the /boot/loader.conf file if it does not exist.  Put in the custom
 > splash information with what is defined above.  That is how I did it on my
 > system.  Now, if you do not define a splash image, then yes I'm sure it
 > would look in the module path (without looking at the code nor any other
 > manual page/documentation besides loader.conf(5)).  Try my suggestion
 > above and let me know if that fixes your problem.  Thanks.
 
 The problem is not, that the splash screen doesn't work; actually it does, either with absolute paths or the image file 
 in the module path. But the splash.4 man page and /boot/defaults/loader.conf don't use absolute paths in their example 
 sections, which is misleading. Look into my diffs, I think they make things clearer.
 
 
 --- splash.4.orig       Sun Jul  6 19:31:28 2003
 +++ splash.4    Sun Jul  6 20:05:51 2003
 @@ -192,11 +192,11 @@
   .Bd -literal -offset indent
   splash_bmp_load="YES"
   bitmap_load="YES"
 -bitmap_name="chuck.bmp"
 +bitmap_name="/boot/chuck.bmp"
   .Ed
   .Pp
   In the above example, the file
 -.Pa chuck.bmp
 +.Pa /boot/chuck.bmp
   is loaded.
   In the following example, the VESA module
   is loaded so that a bitmap file which cannot be displayed in standard
 @@ -205,7 +205,7 @@
   splash_pcx_load="YES"
   vesa_load="YES"
   bitmap_load="YES"
 -bitmap_name="chuck.pcx"
 +bitmap_name="/boot/chuck.pcx"
   .Ed
   .Pp
   If the VESA support is statically linked to the kernel, it is not
 @@ -219,6 +219,13 @@
   only.
   They are not available for the alternative console driver
   .Xr pcvt 4 .
 +.Pp
 +The loader looks for the bitmap file in the kernel module folders as
 +defined by the module_path variable in
 +.Pa /boot/defaults/loader.conf .
 +These folders however are no sensible place for the bitmap file, as
 +they will be renamed by "make world". For the location of the bitmap
 +file absolute paths are therefore recommended.
   .Sh BUGS
   If you load a screen saver while another screen saver has already
   been loaded, the first screen saver will not be automatically unloaded
 
 
 
 --- loader.conf.orig    Sun Jul  6 20:09:26 2003
 +++ loader.conf Sun Jul  6 20:12:45 2003
 @@ -37,8 +37,8 @@
   splash_pcx_load="NO"           # Set this to YES for pcx splash screen!
   vesa_load="NO"                 # Set this to YES to load the vesa module
   bitmap_load="NO"               # Set this to YES if you want splash screen!
 -bitmap_name="splash.bmp"       # Set this to the name of the bmp or pcx file
 -bitmap_type="splash_image_data" # and place it on the module_path
 +bitmap_name="/boot/splash.bmp" # Set this to the name of the bmp or pcx file
 +bitmap_type="splash_image_data"        # Tells loader the image is no kernel module
 
 
   ##############################################################
 
 
 
Responsible-Changed-From-To: freebsd-doc->trhodes 
Responsible-Changed-By: trhodes 
Responsible-Changed-When: Sat Aug 9 12:28:52 PDT 2003 
Responsible-Changed-Why:  
I engaged in most of the conversation in regards to this PR, therefor assign it 
to me. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=54009 
State-Changed-From-To: open->closed 
State-Changed-By: trhodes 
State-Changed-When: Sun Oct 8 00:07:40 UTC 2006 
State-Changed-Why:  
Issues in PR already resolved in 6.X and CURRENT. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=54009 
>Unformatted:
