1.\" Copyright (c) 2011 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 May 18, 2011 28.Dt DELAY.4TH 8 29.Os 30.Sh NAME 31.Nm delay.4th 32.Nd FreeBSD debugging boot module 33.Sh DESCRIPTION 34The file that goes by the name of 35.Nm 36is a set of commands designed to add debugging capabilities to 37.Xr loader 8 . 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 delay.4th 52.Pp 53This line is present in 54.Pa /boot/beastie.4th 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 delay_execute 61Executes the [string] procedure stored in the 62.Ic delay_command 63environment variable after 64.Ic loader_delay 65seconds. 66.Pp 67If the optional 68.Ic delay_showdots 69environment variable is set, a continuous series of dots is printed. 70.Pp 71During the duration, the user can either press Ctrl-C (or Esc) to abort or 72ENTER to proceed immediately. 73.El 74.Pp 75The environment variables that effect its behavior are: 76.Bl -tag -width bootfile -offset indent 77.It Va delay_command 78The command to be executed by 79.Ic delay_execute . 80.It Va loader_delay 81The duration (in seconds) to delay before executing 82.Ic delay_command . 83.It Va delay_showdots 84If set, will cause 85.Ic delay_execute 86to print a continuous series of dots during the delay duration. 87.El 88.Sh FILES 89.Bl -tag -width /boot/loader.4th -compact 90.It Pa /boot/loader 91The 92.Xr loader 8 . 93.It Pa /boot/delay.4th 94.Nm 95itself. 96.It Pa /boot/loader.rc 97.Xr loader 8 98bootstrapping script. 99.El 100.Sh EXAMPLES 101Introducing a 5-second delay before including another file from 102.Pa /boot/loader.rc : 103.Pp 104.Bd -literal -offset indent -compact 105include /boot/delay.4th 106set delay_command="include /boot/other.4th" 107set delay_showdots 108set loader_delay=5 109delay_execute 110.Ed 111.Sh SEE ALSO 112.Xr loader.conf 5 , 113.Xr beastie.4th 8 , 114.Xr loader 8 , 115.Xr loader.4th 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