\input texinfo
@setfilename flan.info
@include version.texi
@documentencoding UTF-8
@copying
This is edition @value{EDITION} of the manual for Flan Local-Access
Notifier, Version @value{VERSION}, last updated on @value{UPDATED}.

@uref{http://www.next.gen.oh.us/users/asm/flan/}

Copyright @copyright{} 2025, 2026 Anton McClure
@uref{http://www.next.gen.oh.us/users/asm/}

@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation; with
no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled ``GNU Free
Documentation License''.
@end quotation
@end copying
@titlepage
@title Flan Local-Access Notifier
@subtitle Manual Edition @value{EDITION}
@subtitle Flan Version @value{VERSION}, @value{UPDATED-MONTH}
@author Anton McClure
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@node Top
@top Flan Local-Access Notifier

@menu
* Introduction::
* Settings::
* GNU Free Documentation License::
@end menu

@node Introduction
@chapter Introduction
@anchor{introduction}

The Flan Local-Access Notifier (aka Flan) is a free digital
calendar signage software, originally written for use at the
University of Akron's College of Business.  Flan is maintained
by @uref{http://www.next.gen.oh.us/users/asm/,Anton McClure}
@email{asm@@next.gen.oh.us,<asm@@next.gen.oh.us>}.

@menu
* Downloading Flan::
* Running Flan::
@end menu

@node Downloading Flan
@section Downloading Flan
@anchor{downloading-flan}

Flan is freely available at
@uref{http://www.next.gen.oh.us/users/asm/flan/}.  It is released
under the GNU General Public Licence version 3 or later.  See the file
@code{COPYING} for details.

Tarballs downloads are available from NEXT's FTP server over either
the @uref{ftp://ftp.next.gen.oh.us/users/asm/flan/,FTP},
@uref{http://ftp.next.gen.oh.us/users/asm/flan/,HTTP}, and
@uref{https://ftp.next.gen.oh.us/users/asm/flan/,HTTPs} protocols.


@menu
* Requirements::
@end menu

@node Requirements
@subsection Requirements
@anchor{requirements}

Flan requires the following packages:

@itemize
@item
Build-time

@itemize
@item
GNU Make

@item
C compiler with C89 support (e.g., GCC)

@item
X11 development headers and library

@item
XPM development headers and library

@item
ical development headers and library

@end itemize

@item
Run-time

@itemize
@item
Xorg-compatible display server

@item
X11 library

@item
XPM library

@item
ical library

@end itemize
@end itemize

@node Running Flan
@section Running Flan
@anchor{running-flan}

Assuming that you've got a Flan configuration file set up already,
simply run the command:

@verbatim
$flan /optional/path/to/config
@end verbatim

If your are not currently using X11, you should run it with xinit like so:

@verbatim
$xinit flan /optional/path/to/config
@end verbatim

If all goes well, Flan should open on your current TTY.  If you want to
automate Flan, you may use the included systemd service file to do so.
By default, the systemd script is configured to use TTY7 as Flan is
intended to run standalone without an underlying desktop environment or
window manager.

If you need to set up your config file, the next chapter, "Settings",
goes over all of the settings categories and options that you will find
in the standard issue sample config.

@node Settings
@chapter Settings
@anchor{settings}

A sample configuration file may be found at
@uref{http://www.next.gen.oh.us/users/asm/flan/flan.cfg}.
The settings are described below as follows.  At the end of the chapter is
all of the settings as they will appear in the sample configuration file.

@menu
* Main Settings::
* Font Settings::
* Color Settings::
* Text Settings::
* ICS Settings::
* All Together::
@end menu

@node Main Settings
@section Main Settings
@anchor{main-settings}

These, long with ICS files, were the first editable options in Flan, with the goal of making it useful for more than just room 101 at the University of Akron College of Business.

@vtable @code
@item @strong{refresh}

Time between data reloads.

@item @strong{days}

Number of days shown on-screen.

@item @strong{logo}

XPM image file used as on-screen logo.

@item @strong{title}

Title of calendar/organization.

@item @strong{regex}

Expression used to separate title and subtitle

@end vtable

@node Font Settings
@section Font Settings
@anchor{font-settings}

All of the fonts must be written using the X Logical Font Description
(XLFD) format.

@vtable @code
@item @strong{m}

Primary calendar font

@item @strong{a}

Secondary header font

@item @strong{l}

Primary header font

@item @strong{d}

Secondary calendar font

@item @strong{i}

Info bar font

@end vtable

@node Color Settings
@section Color Settings
@anchor{color-settings}

@vtable @code
@item @strong{t_bgc}

Header background color

@item @strong{t_txt}

Header text color

@item @strong{b_bgc}

Calendar background color

@item @strong{b_txt}

Calendar text color

@item @strong{s_bgc}

Info bar background color

@item @strong{s_txt}

Info bar text color

@item @strong{c_bgc}

Cell background color

@end vtable

@node Text Settings
@section Text Settings
@anchor{text-settings}

Text is just written with the left and right sides separated by @samp{\\}.
This is not the default text, but Anton did not like how the PDF copy
formatted it when the default text was used here.

@samp{Left side text\\Right side text}

@node ICS Settings
@section ICS Settings
@anchor{ics-settings}

Calendars are just written as title=link.

@samp{Test 1=ftp://ftp.example.cascaded.org/cal/test1.ics}

@node All Together
@section All Together
@anchor{all-together}

All of the default settings as intended may look something like this:

@example
; SPDX-License-Identifier: GPL-3.0-or-later
;
; Sample flan.cfg for Flan
; http://www.next.gen.oh.us/users/asm/flan/
;
; Copyright (C) 2025-2026 Anton McClure
;
; Author: Anton McClure <asm@@next.gen.oh.us>

[main]
refresh=3600
days=3
logo=/usr/local/share/flan/default.xpm
title=Planning Flan
regex=^(.+)[[:space:]]?--[[:space:]]?(.*)

[fonts]
m=-*-helvetica-medium-r-normal-*-20-*-*-*-*-*-*-*
a=-*-times-bold-r-normal-*-24-*-*-*-*-*-*-*
l=-*-new century schoolbook-bold-r-normal-*-34-*-*-*-*-*-*-*
d=-*-helvetica-medium-r-normal-*-17-*-*-*-*-*-*-*
i=-*-new century schoolbook-medium-r-*-*-17-*-*-*-*-*-*-*

[colors]
t_bgc=#4A6B8C
t_txt=#FFFFFF
b_bgc=#CCD3D7
b_txt=#224466
s_bgc=#3A5B71
s_txt=#E3E3E5
c_bgc=#FFFFFF

[text]
This is the planning flan\\This is test text
Save this to /etc/flan.cfg\\and edit as needed.

[ics]
[ics]
Test 1=/usr/local/share/flan/test1.ics
Test 2=/usr/local/share/flan/test2.ics
Test 3=/usr/local/share/flan/test3.ics
@end example

@node GNU Free Documentation License
@chapter GNU Free Documentation License
@anchor{gfdl}
@include gfdl.texi

@bye