xref: /netbsd-src/usr.sbin/screenblank/screenblank.1 (revision 481fca6e59249d8ffcf24fef7cfbe7b131bfb080)
1.\"	$NetBSD: screenblank.1,v 1.7 1999/08/16 20:10:37 is Exp $
2.\"
3.\" Copyright (c) 1996 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 June 7, 1995
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 timeout
47.Op Fl e Ar timeout
48.Op Fl f Ar framebuffer
49.Sh DESCRIPTION
50.Nm Screenblank
51disables the framebuffer if the keyboard and mouse are idle for a period
52of time, and re-enables the framebuffer when keyboard or mouse activity
53resumes.
54.Pp
55When killed with a SIGINT, SIGHUP, or SIGTERM,
56.Nm screenblank
57will re-enable the framebuffer.  The pid can be found in the file
58.Pa /var/run/screenblank.pid .
59.Pp
60The options are as follows:
61.Bl -tag -width indent
62.It Fl k
63Do not check the keyboard for activity.
64.It Fl m
65Do not check the mouse for activity.
66.It Fl d Ar timeout
67Wait the number of seconds specified by
68.Ar timeout ,
69expressed in the format `xxx.xxx', before disabling the framebuffer due to
70inactivity.  The default is 600 seconds (10 minutes).
71.It Fl e Ar timeout
72Wait the number of seconds specified by
73.Ar timeout ,
74expressed in the format `xxx.xxx', before re-enabling the framebuffer once
75activity resumes.  The 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.El
82.Pp
83Note that the
84.Fl k
85and
86.Fl m
87flags are mutually exclusive.
88.Sh FILES
89.Bl -tag -width "/var/run/screenblank.pid  "
90.It /dev/kbd
91The keyboard device.
92.It /dev/mouse
93The mouse device.
94.It /dev/console
95The console device.
96.It /dev/fb
97The default framebuffer.
98.It /dev/wskbd0
99The keyboard for wscons machines.
100.It /dev/wsmouse0
101The mouse device for wscons machines.
102.It /dev/ttyE0
103The console device for wscons machines.
104.It /var/run/screenblank.pid
105File containing the pid of
106.Nm screenblank .
107.El
108