From 7d42d9d2db950eaea8064238a99ac2c38faf43f9 Mon Sep 17 00:00:00 2001 From: Arun Isaac Date: Tue, 21 Feb 2017 23:25:06 +0530 Subject: Add function documentation to README. * README.org: Add function documentation. --- README.org | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.org b/README.org index b83778b..94e053b 100644 --- a/README.org +++ b/README.org @@ -2,6 +2,36 @@ el-exiftool is an elisp wrapper around [[http://www.sno.phy.queensu.ca/~phil/exi editor. Exiftool supports reading and writing metadata in various formats including [[wikipedia:Exif][EXIF]], [[wikipedia:Extensible_Metadata_Platform][XMP]] and [[wikipedia:IPTC_Information_Interchange_Model][IPTC]]. +* Functions + +** (el-exiftool-read FILE TAG...) + +Read TAGs from FILE, and return an alist mapping tag names to +corresponding values. + +** (el-exiftool-write FILE (TAG . VALUE)...) + +Write tags to FILE. + +The metadata to be written is specified as (TAG . VALUE) pairs. + +** (el-exiftool-copy SOURCE DESTINATION) + +Copy tags from SOURCE file to DESTINATION file. + +** (el-exiftool-command &rest ARGS) + +Execute a command in the currently running exiftool process. +If there is no running exiftool process, a new one will be +created. ARGS are arguments of the command to be run, as provided +to the exiftool command line application. + +** (el-exiftool-run) + +Start an exiftool process if not already running. +If an exiftool process is already running, delete it, and create +a new one. Return the process object of the newly created +process. * License -- cgit v1.2.3