xref: /netbsd/usr.sbin/screenblank/screenblank.1 (revision bf9ec67e)
1.\"	$NetBSD: screenblank.1,v 1.11 2002/01/24 01:34:13 lukem 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.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd January 24, 2002
38.Dt SCREENBLANK 1
39.Os
40.Sh NAME
41.Nm screenblank
42.Nd screen saver daemon for wscons and FBIO machines
43.Sh SYNOPSIS
44.Nm screenblank
45.Op Fl k | Fl m
46.Op Fl d Ar inactivity-timeout
47.Op Fl e Ar wakeup-delay
48.Op Fl f Ar framebuffer
49.Op Fl i Ar input-device
50.Sh DESCRIPTION
51.Nm
52disables the framebuffer if the keyboard and mouse are idle for a period
53of time, and re-enables the framebuffer when keyboard or mouse activity
54resumes.
55.Pp
56When killed with a SIGINT, SIGHUP, or SIGTERM,
57.Nm
58will re-enable the framebuffer.  The pid can be found in the file
59.Pa /var/run/screenblank.pid .
60.Pp
61The options are as follows:
62.Bl -tag -width indent
63.It Fl k
64Do not check the keyboard for activity.
65.It Fl m
66Do not check the mouse for activity.
67.It Fl d Ar inactivity-timeout
68Wait the number of seconds specified by
69.Ar inactivity-timeout ,
70expressed in the format `xxx.xxx', before disabling the framebuffer due to
71inactivity.  The default is 600 seconds (10 minutes).
72.It Fl e Ar wakeup-delay
73Wait the number of seconds specified by
74.Ar wakeup-delay ,
75expressed in the format `xxx.xxx', before re-enabling the framebuffer once
76activity resumes.  The default is .25 seconds.
77.It Fl f Ar framebuffer
78Use the framebuffer device
79.Ar framebuffer
80instead of the default
81.Pa /dev/fb .
82.It Fl i Ar input-device
83Add
84.Ar input-device
85to the list of devices to monitor for activity.
86.El
87.Pp
88Note that the
89.Fl k
90and
91.Fl m
92flags are mutually exclusive.
93.Sh FILES
94.Bl -tag -width "/var/run/screenblank.pid  "
95.It /dev/kbd
96The keyboard device.
97.It /dev/mouse
98The mouse device.
99.It /dev/console
100The console device.
101.It /dev/fb
102The default framebuffer.
103.It /dev/wskbd
104The keyboard for wscons machines.
105.It /dev/wsmouse
106The mouse device for wscons machines.
107.It /dev/ttyE0
108The console device for wscons machines.
109.It /var/run/screenblank.pid
110File containing the pid of
111.Nm "" .
112.El
113