1.\" Copyright (c) 2011-2013 Devin Teske 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd August 6, 2013 28.Dt VERSION.4TH 8 29.Os 30.Sh NAME 31.Nm version.4th 32.Nd FreeBSD version string boot module 33.Sh DESCRIPTION 34The file that goes by the name of 35.Nm 36is a set of commands designed to draw the boot loader 37version at the bottom-right of the screen. 38The commands of 39.Nm 40by themselves are not enough for most uses. 41Please refer to the 42examples below for the most common situations, and to 43.Xr loader 8 44for additional commands. 45.Pp 46Before using any of the commands provided in 47.Nm , 48it must be included 49through the command: 50.Pp 51.Dl include version.4th 52.Pp 53This line is present in the default 54.Pa /boot/menu.rc 55file, so it is not needed (and should not be re-issued) in a normal setup. 56.Pp 57The commands provided by it are: 58.Pp 59.Bl -tag -width disable-module_module -compact -offset indent 60.It Ic print_version 61Prints the contents of the 62.Va loader_version 63environment variable right-justified at the column 64.Va loader_version_x 65and row 66.Va loader_version_y . 67.El 68.Pp 69The environment variables that effect its behavior are: 70.Bl -tag -width bootfile -offset indent 71.It Va loader_version 72Set automatically by 73.Xr loader 8 , 74but you can override it by setting in 75.Xr loader.conf 5 . 76This should be the version of boot loader used. 77.It Va loader_version_x 78Sets the desired ending column position of 79.Va loader_version . 80Default is 80. 81.It Va loader_version_y 82Sets the desired ending row position of 83.Va loader_version . 84Default is 24. 85.It Va loader_color 86If set to 87.Dq Li NO 88(case-insensitive) or 89.Dq Li 0 , 90causes the version to be printed without color 91.Pq default is ANSI Cyan . 92.El 93.Sh FILES 94.Bl -tag -width /boot/version.4th -compact 95.It Pa /boot/loader 96The 97.Xr loader 8 . 98.It Pa /boot/version.4th 99.Nm 100itself. 101.It Pa /boot/loader.rc 102.Xr loader 8 103bootstrapping script. 104.El 105.Sh EXAMPLES 106Override 107.Xr loader 8 108version in 109.Xr loader.conf 5 : 110.Pp 111.Bd -literal -offset indent -compact 112loader_version="loader 1.1" 113.Ed 114.Sh SEE ALSO 115.Xr loader.conf 5 , 116.Xr color.4th 8 , 117.Xr loader 8 118.Sh HISTORY 119The 120.Nm 121set of commands first appeared in 122.Fx 9.0 . 123.Sh AUTHORS 124The 125.Nm 126set of commands was written by 127.An -nosplit 128.An Devin Teske Aq dteske@FreeBSD.org . 129