surf-display-openbsd/data/surf-display.1

40 lines
1.5 KiB
Groff

'\" -*- coding: utf-8 -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH surf-display 1 "Jun 2017" "Version 0.0.5" "Surf Kiosk Display"
.SH NAME
surf-display \- Fullscreen WWW Display Session Manager
.SH SYNOPSIS
'nh
.fi
.ad l
\fBsurf-display\fR
.SH DESCRIPTION
\fBsurf-display\fR is a wrapper around Surf. It can turn a system into a browser based display terminal in KIOSK mode.
.PP
\fBsurf-display\fR registers itself as an x-session-manager alternative
and provides a very minimal X11 session, launching the
matchbox-window-manager, pulseaudio (if requested) and unclutter (if
requested) before starting the fullscreen browser session.
.PP
\fBsurf-display\fR locks down mouse pointer right-click behaviour and disables various keyboard shortcuts to hide Surf
functionalities from the user. Out goal is to not let users break out of the given entry WWW site's browsing design.
.PP
You can combine \fBsurf-display\fR with a local \fBtinyproxy\fR setup to configure access to specific sites and configure
what sites to block user access from.
.PP
.SH OPTIONS
\fBsurf-display\fR can easily be configured system-wide via /etc/default/surf-display. Overrides can be configure on a per-user basis
via $HOME/.surf-display/config.
.PP
.SH SEE ALSO
/etc/default/surf-display
.SH AUTHOR
This manual has been written by Mike Gabriel <mike.gabriel@das-netzwerkteam.de> and Benjamin Schlüter <bschlueter@posteo.de> for the IT-Zukunft-Schule
project (https://wiki.it-zukunft-schule.de/).