Commits

Andreas Tscharner committed 8c11da4

Updated man page for RIF file format

  • Participants
  • Parent commits 9efd195

Comments (0)

Files changed (1)

-.TH lrc 5 "26 August 2011" "lrc 0.4"
+.TH lrc 5 "29 September 2011" "lrc 0.4"
 
 .SH NAME
 lrc \- Linux Resource Compiler
 
 .TP
 .I Compression
-Define the compression algorithm that should be used to compress this resource. The following algorithms are available:
-
-.B None - No compression
-
-.B zLib - zlib compression
+Define the compression algorithm that should be used to compress this resource. All evailable compression algorithms are described in the compression section.
 
 .TP
 .I Encryption
-Define the encryption algorithm that should be used the encrypt this resource. The following algorithms are available:
-
-.B None - No encryption
-
-.B Serpent - Encrypted with Serpent algorithm
+Define the encryption algorithm that should be used the encrypt this resource. All available encryption algorithms are described in the encryption section.
 
 .TP
 .I Password
 A password if an encryption other than None is selected. It has to be in double quotes to allow (and therefore also avoid problems with) spaces.
 
 .TP
-The compression and encryption (and the password) parameters are optional. If they are omitted, the resource will not be compressed or encrypted.
+The compression and encryption (and the password) parameters are optional. If they are omitted, the resource will be neither compressed nor encrypted.
 
 .SH RIFFile
-To be described as soon as it is implemented.
+Definition of the XML file format for lrc
+
+.TP
+The RIF file is a XML file. The root element is \<Resources\>. It contains one or more \<Resource\> (note the missing 's' at the end) elements and has no attributes.
+
+.TP
+The text of the \<Resource\> tag defines the file path to the file to be added as resource. Furthermore the \<Resource\> tag contains the following attributes:
+
+.TP
+.I id
+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 compression
+The compression attribute defines the algorithm that should be used to compress this resource. All available compression algorithms are described in the compression section.
+
+.TP
+.I encryption
+The encryption attribute defines the algorithm that should be used to encrypt this resource. All available encryption algorithms are described in the encryption section.
+
+.TP
+.I password
+The password attribute defines the password for the encryption. It is required unless the encryption attribute is omitted or None.
+
+.TP
+The compression and encryption (and the password) attributes are optional. If they are omitted, the resource will be neither compressed nor encrypted.
+
+.SH Compression
+The following compression algorithms are available:
+
+.B None - No compression
+
+.B zLib - zlib compression
+
+.SH Encryption
+The following encryption algorithms are available:
+
+.B None - No encryption
+
+.B Serpent - Encrypted with Serpent algorithm
 
 .SH AUTHORS
 lrc was written by Andreas Tscharner <andy@vis.ethz.ch>