Commits

Andreas Tscharner committed f5f91d9

Add man page for file format and fix incorrect reference in lrc.1

  • Participants
  • Parent commits 4d692e4

Comments (0)

Files changed (3)

File man/Makefile.am

 
 #
 # Man pages
-man_MANS = lrc.1
+man_MANS = lrc.1 lrc.5
-.TH lrc 1 "31 July 2011" "lrc 0.1.99"
+.TH lrc 1 "1 August 2011" "lrc 0.1.99"
 
 .SH NAME
 lrc \- Linux Resource Compiler
 Input file in XML format; defines all used files to compile.
 
 .SH FILES
-.I RCFile(5)
-.I RIFFile(5)
+.I RCFile
+.I RIFFile
 .RS
 Input files that define files to compile into a resource file. The format is described in
 .I lrc.5
+.TH lrc 5 "1 August 2011" "lrc 0.1.99"
+
+.SH NAME
+lrc \- Linux Resource Compiler
+
+.SH RCFile
+Definition of the simple RC file format for lrc
+
+.TP
+The format of the RC file is line based. An empty line or a line beginning with '#' is ignored
+
+.TP
+All other lines are parsed as follows:
+.TP
+.B ResourceID\ \ \ \ \ "Resource File"\ \ \ \ \ Compression\ \ \ \ \ Encryption
+
+.TP
+The delimiter between the fields has to be at least 2(!) whitespaces (space or tab)
+
+.TP
+.I ResourceID
+Alphanumeric identifier for the resource. This ID is needed to load the desired resource from within a program and has to be unique.
+
+.TP
+.I Resource File
+The resource file is a file path to the file to be added as resource. It has to be in double quotes to avoid problems with spaces in the filename
+
+.TP
+.I Compression
+Define the compression algorithm that should be used to compress this resource. The following algorithms are available:
+
+.B None - No compression
+
+.TP
+.I Encryption
+Define the encryption algorithm that should be used the encrypt this resource. The following algorithms are available:
+
+.B None - No encryption
+
+.TP
+The compression and encryption parameters are optional. If they are omitted, the resource will not be compressed or encrypted.
+
+.SH RIFFile
+To be described as soon as it is implemented.
+
+.SH AUTHORS
+lrc was written by Andreas Tscharner <andy@vis.ethz.ch>
+
+.SH SEE ALSO
+.I lrc(1)
+Description of the compiler