SYNTAX
zophExport [--help] --dir dir --format zoph|album|bins [--album "album"] [--category "category [, category]"] [--photographer "first_name last_name"] [--people "first_name last_name [, first_name last_name]"] [--location ["place_title"] [--field name="value"] [--sql sql_statement] [--lang file] [--[no]albumdirs] [--[no]subalbums] [--[no]subcategories] [--[no]showdate] [--[no]showtitle] [--[no]showview] [--[no]showpeople] [--[no]showphotographer] [--[no]showlocation] [--[no]showdescription] [--[no]showexif] [--[no]showfooter]
DESCRIPTION
zophExport is the command line exporter for the zoph (Zoph Organizes PHotos) web photo management system. Specify the destination of the export using --dir and the format of the export using --format. The format must be one of "zoph", "album", or "bins". The zoph format creates a gallery using a simple, built-in generator. The album format creates an export compatible with the album program, the bins format creates an export compatible with the bins program.Photos can appear in multiple albums and categories, and multiple people can be in a photo. To handle this, you can either pass a comma separated list or set the flag multiple times. Actually, you can use a comma separated list for categories and people but not for albums (since I realized that I have many albums with commas in their names and have yet to build an escape mechanism).
The exporter creates static albums in various formats to be used on webhosting services where you don't have MySQL, when you don't want all your pictures to be published or to burn them onto a CD for offline-browsing. Multiple options are ANDed, cutting down the resulting set of images. The set can be increased again by running zophExport multiple times. SQL hackers can select images by arbitrary SQL statements and finally the set of images can be modified manually before transfer to the web host or CD.
Most fields match using the equals operator. Two exceptions are rating (which defaults to >=) and description (which defaults to like).
OPTIONS
The `"' around arguments are needed to prevent breaking up around whitespace or the shell interpreting special characters. If an album e.g. is called hugo you can omit them.- --help
- lists all supported options and quits
- --dir dir
- toplevel directory for exported hierarchy
- --format zoph|album|bins
- the format to use: zoph is a very simple yet quick built-in format (the thumbnails don't have to be calculated, no additional software needed), album for David Ljung Madisons "Album" script (http://marginalhacks.com/Hacks/album/ ) and bins for Jérôme Sautrets "bins" script (http://bins.sautret.org/ ); both are available as Debian packages
- --album "album"
- select the album(s) to export
- --category "category [, category]"
- select the category(s) to export
- --photographer "first_name last_name"
- select the photographer whose pictures should be exported
- --people "first_name last_name [, first_name last_name]"
- select pictures by the people being shown
- --location "place_title"
- select pictures by location being shown
- --field name="value"
- select pictures by its field name; common fields are title (text, 64 chars max), view (text, 64 chars max), description (text), rating (1..10) or level (1..10); possible fields are from the MySQL database, table photos;
- --sql sql_statement
- select pictures by self-defined SQL statement
- --lang file
- The exporter can translate field labels using the same language files that Zoph uses. Pass --lang /usr/share/zoph/lang/XX to enable this option.
The following options can be used with or without "no" prepended. The default behaviour is without "no", explained is the option when used with "no".
- --[no]albumdirs
- By default the exporter creates directories to mirror the structure of the albums in which the exported photos appear. Use this flag to disable this and have all images exported into the given directory dir.
- --[no]subalbums
- don't export subalbums below the selected one
- --[no]subcategories
- don't export subcategories below the selected one
By default zophExport.pl will export everything about your photos except the
last modified time, the rating and the albums or categories in which the photo
appears. To prevent the display of a particular field, use the --noshowFIELD
argument. For example: --noshowlocation or --noshowdescription. Passing
--noshowexif prevents any exif info from being shown. (Note, however, that the
BINS program extracts exif info on its own).
- --[no]showdate
- don't export the date
- --[no]showtitle
- don't export the title
- --[no]showview
- don't export the view
- --[no]showpeople
- don't export the people's names
- --[no]showphotographer
- don't export the photographer's name
- --[no]showlocation
- don't export the location
- --[no]showdescription
- don't export the description
- --[no]showexif
- don't export the Exif data
- --[no]showfooter
- don't show a footer
EXAMPLES
- zophExport --dir "~/Winter Pics" --format album --category Snow
In this simple example all photos placed in the Snow category are exported. Within the "Winter Pics" directory zophExport will have created a directory structure mirroring the album structure in Zoph for the selected photos.
- zophExport --dir "~/My Album" --format album --album "Boston Trip" --photographer "Jason Geiger" --field rating=5
Only photos I took on my trip to Boston that I rated 5 or more would be exported. By default subalbums of an album are automatically included (so my "Duck Tour" subalbum is also exported).
CONFIGURATION FILE
Configuration for both zophImport.pl and zophExport.pl are stored in $HOME\.
zophrc. An example file is included with Zoph.
The following settings need to be made in order to make zophImport.pl and zophEx
port.pl work:
- $db_host:
- Hostname or IP address of your MySQL server.
- $db_name:
-
Name of the database.
- $db_user:
- Username Zoph should use to log on to the MySQL server.
- $db_pass:
- Password Zoph should use.
- $db_prefix:
- Prefix to include before each tablename (in order to enable sharing of the Zoph database with other apps - for example if you have a limitted number of databases with your hosting account).
- $image_dir:
- Location of your photos. Make sure it ends with /. Note that these settings should have a matching entry in config.inc.php.
AUTHORS
zoph was written by Jason Geiger <[email protected]> and is now maintained by Jeroen Roos <[email protected]>
this manpage was created by Edelhard Becker <[email protected]> and updated by Jeroen Roos <[email protected]>