zoneminder: Improve pkgsrc README

[Greg Troxel <gdt%lexort.com@localhost>]

Module Name:	pkgsrc-wip
Committed By:	Greg Troxel <gdt%lexort.com@localhost>
Pushed By:	gdt
Date:		Mon Sep 26 20:44:23 2022 -0400
Changeset:	4f721f9df1db57b1f3f81813757a072da7b34988

Modified Files:
	zoneminder/files/README-pkgsrc.md

Log Message:
zoneminder: Improve pkgsrc README

To see a diff of this commit:
https://wip.pkgsrc.org/cgi-bin/gitweb.cgi?p=pkgsrc-wip.git;a=commitdiff;h=4f721f9df1db57b1f3f81813757a072da7b34988

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

diffstat:
 zoneminder/files/README-pkgsrc.md | 41 +++++++++++++++++++++++++++------------
 1 file changed, 29 insertions(+), 12 deletions(-)

diffs:
diff --git a/zoneminder/files/README-pkgsrc.md b/zoneminder/files/README-pkgsrc.md
index db47d940f6..c162f530ed 100644
--- a/zoneminder/files/README-pkgsrc.md
+++ b/zoneminder/files/README-pkgsrc.md
@@ -1,13 +1,15 @@
-===========================================================================
-$NetBSD: MESSAGE,v 1.5 2021/12/31 12:07:55 dsainty Exp $
+# Introduction
 
-Performance:
+This is a local pkgsrc README for the zoneminder package.  It attempts
+not to duplicate the upstream documentation.
 
-  ZoneMinder benefits dramatically from using libjpeg-turbo.  Consider
-  building from Pkgsrc with:
+# jpeg implementation
 
-  JPEG_DEFAULT=libjpeg-turbo
+ZoneMinder benefits dramatically from using libjpeg-turbo.  Consider
+setting that as default in mk.conf, and rebuilding *everything*, via
+`JPEG_DEFAULT=libjpeg-turbo`.
 
+# Initial database creation
 
 To get ZoneMinder started a MySQL database is required.
 
@@ -18,27 +20,42 @@ echo "create user 'zmuser'@'localhost' identified by 'zmpass';" | mysql -u root
 The default password is "zmpass".  You may change this to something else, and
 update ZM_DB_PASS in ${PKG_SYSCONFDIR}/zm.conf.
 
-
 Create the initial database via:
 
   mysql -u root < ${PREFIX}/share/zoneminder/db/zm_create.sql
 
-
 Assign rights to the "zmuser" user via:
 
   echo "grant all on * to 'zmuser';" | mysql -u root zm
 
+# Upgrading from previous versions
 
 Upgrade a database from an older version of ZoneMinder via:
 
   zmupdate.pl -u root [-p <password>]
 
+# web setup
 
 To enable the web interface via Apache, add the following line to httpd.conf:
 
   Include ${PREFIX}/share/examples/zoneminder/apache/zoneminder.conf
 
-PHP may log warnings if the PHP date.timezone configuration is not set.
-Consider assigning a default system time zone to date.timezone in
-${PKG_SYSCONFDIR}/php.ini.
-===========================================================================
+PHP may log warnings if the PHP date.timezone configuration is not
+set.  Consider assigning a default system time zone to date.timezone
+in ${PKG_SYSCONFDIR}/php.ini.  [This paragraph might be old advice.]
+
+# Shared memory
+
+With 1.30, zoneminder tries to use a shm filesystem to store files
+that are then mmap'd, instead of system V shm.
+
+On NetBSD, the default might be /dev/shm but the right place is
+/var/shm.  This can be changed in Options in the web interface.
+
+One might need a lot of space, or to turn the buffer down to fewer frames.
+
+Somtimes, the shm file can get into a bad state and be zero length.
+This might be a bad error path during camera timeouts; it seems to
+happen more with bad wifi connections.  Turning up the timeouts in the
+config (e.g. wait 10s or 30s before giving up instead of 2s) probably
+also helps.