NetBSD/usr.sbin/screenblank/screenblank.1

.\"	$NetBSD: screenblank.1,v 1.2 1996/02/28 01:18:32 thorpej Exp $
.\"
.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Jason R. Thorpe.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"        This product includes software developed by the NetBSD
.\"        Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd June 7, 1995
.Dt SCREENBLANK 1
.Os
.Sh NAME
.Nm screenblank
.Nd screen saver daemon for the Sun 3 and SPARC
.Sh SYNOPSIS
.Nm screenblank
.Op Fl k | Fl m
.Op Fl d Ar timeout
.Op Fl e Ar timeout
.Op Fl f Ar framebuffer
.Sh DESCRIPTION
.Nm Screenblank
disables the framebuffer if the keyboard and mouse are idle for a period
of time, and re-enables the framebuffer when keyboard or mouse activity
resumes.
.Pp
When killed with a SIGINT, SIGHUP, or SIGTERM,
.Nm screenblank
will re-enable the framebuffer.  The pid can be found in the file
.Pa /var/run/screenblank.pid .
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl k
Do not check the keyboard for activity.
.It Fl m
Do not check the mouse for activity.
.It Fl d Ar timeout
Wait the number of seconds specified by
.Ar timeout ,
expressed in the format `xxx.xxx', before disabling the framebuffer due to
inactivity.  The default is 600 seconds (10 minutes).
.It Fl e Ar timeout
Wait the number of seconds specified by
.Ar timeout ,
expressed in the format `xxx.xxx', before re-enabling the framebuffer once
activity resumes.  The default is .25 seconds.
.It Fl f Ar framebuffer
Use the framebuffer device
.Ar framebuffer
instead of the default
.Pa /dev/fb .
.El
.Pp
Note that the
.Fl k
and
.Fl m
flags are mutually exclusive.
.Sh FILES
.Bl -tag -width "/var/run/screenblank.pid  "
.It /dev/kbd
The keyboard device.
.It /dev/mouse
The mouse device.
.It /dev/console
The console device.
.It /dev/fb
The default framebuffer.
.It /var/run/screenblank.pid
File containing the pid of
.Nm screenblank .
.El