1.\" $NetBSD: screenblank.1,v 1.18 2019/04/08 20:18:14 sevan Exp $ 2.\" 3.\" Copyright (c) 1996-2002 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Jason R. Thorpe. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd April 8, 2019 31.Dt SCREENBLANK 1 32.Os 33.Sh NAME 34.Nm screenblank 35.Nd screen saver daemon for wscons and FBIO machines 36.Sh SYNOPSIS 37.Nm screenblank 38.Op Fl k | Fl m 39.Op Fl d Ar inactivity-timeout 40.Op Fl e Ar wakeup-delay 41.Op Fl f Ar framebuffer 42.Op Fl i Ar input-device 43.Nm 44.Brq Fl b | Fl u 45.Sh DESCRIPTION 46.Nm 47disables the framebuffer if the keyboard and mouse are idle for a period 48of time, and re-enables the framebuffer when keyboard or mouse activity 49resumes. 50.Pp 51When killed with a SIGINT, SIGHUP, or SIGTERM, 52.Nm 53will re-enable the framebuffer. 54The pid can be found in the file 55.Pa /var/run/screenblank.pid . 56.Pp 57The options are as follows: 58.Bl -tag -width indent 59.It Fl b 60Overriding the other options, simply try (once) to blank the 61framebuffer, then exit. 62.It Fl d Ar inactivity-timeout 63Wait the number of seconds specified by 64.Ar inactivity-timeout , 65expressed in the format 66.Dq xxx.xxx , 67before disabling the framebuffer due to inactivity. 68The default is 600 seconds (10 minutes). 69.It Fl e Ar wakeup-delay 70Wait the number of seconds specified by 71.Ar wakeup-delay , 72expressed in the format 73.Dq xxx.xxx , 74before re-enabling the framebuffer once activity resumes. 75The default is .25 seconds. 76.It Fl f Ar framebuffer 77Use the framebuffer device 78.Ar framebuffer 79instead of the default 80.Pa /dev/fb . 81.It Fl i Ar input-device 82Add 83.Ar input-device 84to the list of devices to monitor for activity. 85.It Fl k 86Do not check the keyboard for activity. 87.It Fl m 88Do not check the mouse for activity. 89.It Fl u 90Overriding the other options, simply try (once) to unblank the 91framebuffer, then exit. 92.El 93.Pp 94Note that the 95.Fl k 96and 97.Fl m 98flags are mutually exclusive. 99.Sh FILES 100.Bl -tag -width "/var/run/screenblank.pid " 101.It /dev/kbd 102The keyboard device. 103.It /dev/mouse 104The mouse device. 105.It /dev/console 106The console device. 107.It /dev/fb 108The default framebuffer. 109.It /dev/wskbd 110The keyboard for wscons machines. 111.It /dev/wsmouse 112The mouse device for wscons machines. 113.It /dev/ttyE0 114The console device for wscons machines. 115.It /var/run/screenblank.pid 116File containing the pid of 117.Nm . 118.El 119.Sh CAVEATS 120.Nm 121checks the access and modification times of the devices it is 122monitoring to determine activity. 123If the devices are on a file system mounted with the 124.Cm noatime 125and/or 126.Cm nodevmtime 127options, it will not function as expected. 128A possible workaround is to use a script as such: 129.Bd -literal -offset indent 130#!/bin/sh 131/usr/sbin/screenblank -d 0 -e 0 && read 132/usr/bin/pkill screenblank 133.Ed 134