Source

lrc / man / lrc.5

.TH lrc 5 "13 January 2013" "lrc 1.0"

.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\ \ \ "Password"

.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. 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. 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 be neither compressed nor encrypted.

.SH RIFFile
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

.B bzip2 - bzip2 compression

.SH Encryption
The following encryption algorithms are available:

.B None - No encryption

.B Serpent - Encrypted with Serpent algorithm

.SH Password
All alphanumeric characters are allowed to be used in the password. If the first character of the password is a '@' the rest of the password string will be interpreted as filename. In this case the file will be loaded and the content of the file will be taken as password to encrypt the resource. Use this method if you want to use other characters than alphanumeric ones.

.SH AUTHORS
lrc was written by Andreas Tscharner <andy@vis.ethz.ch>

.SH SEE ALSO
.I lrc(1)
Description of the compiler
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.