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.Dd August 6, 2013 26.Dt VERSION.4TH 8 27.Os 28.Sh NAME 29.Nm version.4th 30.Nd FreeBSD version string boot module 31.Sh DESCRIPTION 32The file that goes by the name of 33.Nm 34is a set of commands designed to draw the boot loader 35version at the bottom-right of the screen. 36The commands of 37.Nm 38by themselves are not enough for most uses. 39Please refer to the 40examples below for the most common situations, and to 41.Xr loader 8 42for additional commands. 43.Pp 44Before using any of the commands provided in 45.Nm , 46it must be included 47through the command: 48.Pp 49.Dl include version.4th 50.Pp 51This line is present in the default 52.Pa /boot/menu.rc 53file, so it is not needed (and should not be re-issued) in a normal setup. 54.Pp 55The commands provided by it are: 56.Pp 57.Bl -tag -width disable-module_module -compact -offset indent 58.It Ic print_version 59Prints the contents of the 60.Va loader_version 61environment variable right-justified at the column 62.Va loader_version_x 63and row 64.Va loader_version_y . 65.El 66.Pp 67The environment variables that effect its behavior are: 68.Bl -tag -width bootfile -offset indent 69.It Va loader_version 70Set automatically by 71.Xr loader 8 , 72but you can override it by setting in 73.Xr loader.conf 5 . 74This should be the version of boot loader used. 75.It Va loader_version_x 76Sets the desired ending column position of 77.Va loader_version . 78Default is 80. 79.It Va loader_version_y 80Sets the desired ending row position of 81.Va loader_version . 82Default is 24. 83.It Va loader_color 84If set to 85.Dq Li NO 86(case-insensitive) or 87.Dq Li 0 , 88causes the version to be printed without color 89.Pq default is ANSI Cyan . 90.El 91.Sh FILES 92.Bl -tag -width /boot/version.4th -compact 93.It Pa /boot/loader 94The 95.Xr loader 8 . 96.It Pa /boot/version.4th 97.Nm 98itself. 99.It Pa /boot/loader.rc 100.Xr loader 8 101bootstrapping script. 102.El 103.Sh EXAMPLES 104Override 105.Xr loader 8 106version in 107.Xr loader.conf 5 : 108.Pp 109.Bd -literal -offset indent -compact 110loader_version="loader 1.1" 111.Ed 112.Sh SEE ALSO 113.Xr loader.conf 5 , 114.Xr color.4th 8 , 115.Xr loader 8 116.Sh HISTORY 117The 118.Nm 119set of commands first appeared in 120.Fx 9.0 . 121.Sh AUTHORS 122The 123.Nm 124set of commands was written by 125.An -nosplit 126.An Devin Teske Aq dteske@FreeBSD.org . 127