Pilot Log Files

==============================
Pilot Log by Standard Software
==============================

What is Pilot Log
-----------------
A pilot logbook for logging flight time


Project home page http://pilotlog.stansoft.org

Questions? Need Help?
---------------------
Email: info@stansoft.org
================================================================================


====================
Installing Pilot Log
====================

Extract the tarball:

  $ tar xvf pilotlog-XX.x86_64.tar.bz2

Run the Pilot Log install script:

  $ cd pilotlog
  $ ./installpl

Once the install script finishes start Pilot Log:
 
  $ ./pl


Pilot Log also comes packaged in a Fedora RPM, to install the RPM:

  $ sudo dnf install pilotlog-XX-1.fcXX.x86_64.rpm
  $ /usr/lib64/pilotlog/installpl
  $ pilotlog

 
=======
Upgrade
=======

If you are upgrading to a new version, close all terminals running Pilot Log
and stop the PostgreSQL database:

  kill `head -n1 $HOME/.local/share/pilotlog/data/postmaster.pid` 

Extract the downloaded tar archive into a different directory from your current
pilotlog directory. Run the following commands:

  On Fedora when doing a dnf upgrade with a PostgreSQL server major version
  change, you will need to install the previous version upgrade package:
    sudo dnf install postgresql-upgrade
  Then set OLD_BINDIR to /usr/lib64/pgsql/postgresql-15/bin

  mv pilotlog pilotlog-old
  tar -xvf pilotlog-vX-x86_64.tar.bz2
  export OLD_BINDIR=/path/to/old/psql
  export NEW_BINDIR=/path/to/new/psql
  export OLD_DATADIR=$HOME/.local/share/pilotlog/data-old
  export NEW_DATADIR=$HOME/.local/share/pilotlog/data
  mv "$NEW_DATADIR" "$OLD_DATADIR"

Set the PostgreSQL environment
  source /usr/lib64/pilotlog/etc/pilotlog.sh

When creating the new database, the locale and encoding need to be set
the same as the old database. By default they are taken from the system
locale setting, but if you get errors like shown below you may need to
specify them to the initdb command.

  initdb -D "$NEW_DATADIR"
  sed -i 's/#\(logging_collector =\) off/\1 on/' "$NEW_DATADIR"/postgresql.conf
  pg_upgrade --old-bindir="$OLD_BINDIR" \
             --new-bindir="$NEW_BINDIR" \
             --old-datadir="$OLD_DATADIR" \
             --new-datadir="$NEW_DATADIR"

When running pg_upgrade, it might exit with errors similar to these:
  lc_collate values for database "postgres" do not match:  old "C", new "en_US"
  encodings for database "postgres" do not match:  old "LATIN1", new "UTF8"

If you get errors like those then you need to start over and run initdb
again and pass the appropriate settings to it like this:
  initdb --locale=en_US --lc-collate=C --encoding=LATIN1 -D "$NEW_DATADIR"

When pg_upgrade completes with no errors and you verify the old database
imported into the new install, you can remove the old pilotlog directory
and move the new to where you would like it to reside.

Close all terminals running Pilot Log, which will stop the PostgreSQL database.

"$NEW_DATADIR"/delete_old_cluster.sh

Next run the update script, which will update your database:
  cd pilotlog
  ./updatepl


===========
Active Keys
===========
Ctrl-F Perform a find on the current field to search for data.
Ctrl-A Toggle between insert mode and type-over mode in a field.
Ctrl-C Exit a screen without saving changes.
Ctrl-D Delete characters from the cursor position to the end of the field.
Ctrl-X Delete a single character at the cursor.
Esc    Exit a screen and save changes, also runs a query after selecting Find.

=========
Ring Menu
=========
A ring menu is a menu or list of options at the top of the screen. Typical
options include: Find  Next  Previous  Add  Change  Exit.
You can use arrow keys to highlight the option you want and then press enter
to select it or pressing the uppercase character of the menu option you want
will jump directly to that option.

======
Search
======
To search for records, select "Find" from a ring menu, then move into the
field you want to perform the search on and enter your search criteria.
After entering search criteria in one or more fields pressing Esc executes
the search. If you leave all fields blank, then all records will be found.
Wildcards are allowed in the search criteria. Some fields can be populated
by doing Ctrl-F to do a find on a specific field.

Fields that allow for a search will have Ctrl-W listed as an active key
on the top of the screen. When in one of these fields doing Ctrl-W will
show a list of the available operators and syntax for entering search
criteria in the field.

===============
Wildcard Search
===============
Entering "AB*" selects all records beginning with "AB". The "*" matches
any characters after "AB".

A*  Records beginning with "A"
*A* Records containing "A"
*A  Records ending with "A"
A?E Records beginning with "A" and ending with "E"


On startup the following menu items will be displayed:

Pilot Maintenance
  Enter the pilot name and contact information.

Aircraft Type Maintenance
  Enter aircraft type (needs to be setup before entering "N" numbers).

Aircraft Ident Maintenance
  Enter aircraft "N" numbers and type.

Pilot Logbook
  This is the main program for entering flight information.

Weight and Balance
  Program for calculating weight and balance.

Logbook Detail Report
  A report of flight information.

Menu Maintenance
  Add or modify menu items.

Menu Security
  Grant or revoke menu access to users.


===============
Database backup
===============
The PostgreSQL data directory, where all of your data is stored
is located at pilotlog/data. It is possible to simply backup this
directory, but if you do this the database server MUST be shut down
in order to get a usable backup.

To stop the database server:
  kill `head -n1 pilotlog/data/postmaster.pid`

A better and safer method of backup is to use the pg_dump utility, this
can be run while the database server is running. This will generate a text
file that can be used to recreate the database in the same state as it was
at the time of the dump.

You may need to start Pilot Log first in case the database is not running.

Set the PostgreSQL environment (make sure to include the dot space):
. pilotlog/etc/pilotlog.sh

To backup all databases:
  pg_dumpall > file.dump

To restore the dump file:
  dropdb pilotlog
  createdb pilotlog
  psql pilotlog < file.dump