From: Stephan Witt <switt@lyx.org>
Date: Mon, 9 Oct 2017 06:06:17 +0000 (+0200)
Subject: Add description comment for the lyxconvert utility
X-Git-Tag: 2.3.1~140
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=ce28621d9ef6d7f0c37b5c0febef9bd021dc5a51;p=features.git

Add description comment for the lyxconvert utility
---

diff --git a/src/convert/lyxconvert.cpp b/src/convert/lyxconvert.cpp
index b3169a7a73..59e8ea7978 100644
--- a/src/convert/lyxconvert.cpp
+++ b/src/convert/lyxconvert.cpp
@@ -7,6 +7,20 @@
  * \author Enrico Forestieri
  *
  * Full author contact details are available in file CREDITS.
+ *
+ * The code implements an utility program using the Qt-Framework
+ * to convert an image from a given format to another one.
+ * The image format of the files is either auto detected by Qt or
+ * may explicitely specified with command line arguments.
+ *
+ * Syntax:
+ * lyxconvert [-d] [-f infmt] [-t outfmt] inputfile outputfile
+ *  -d   turn on debug messages
+ *  -f   format of input file (from)
+ *  -t   format of output file (to)
+ *
+ * Example to convert a compressed SVG image to PNG:
+ * lyxconvert image.svgz image.png
  */
 
 #include <iostream>