Manpages

Manpage of PILRC

PILRC

Section: PalmOS resource Complier (1)
Updated: perl v5.6.1
Index
Return to Main Contents
 

NAME

pilrc - A resource compiler for the Palm Computing Platform

pilrcui - A graphical editor for PalmOS resource files  

SYNOPSIS

pilrc-L LANGUAGE ] [ -I INCLUDE PATH ]
           [ -D MACRO(=VAL) ] [ -R RESFILE ]
           [ -H INCLUDE PATH ] [ -ro ] [ -q ] [ -V ]
           [ -Fh ] [ -Fj ] [ -F5 ] [ -Fg ]
           [ -Fkm ] [ -Fkt ]
           [ -LE32 ] [ -allowEditID ]
           [ -o OUTPUTPATH ] file.rcp [ output-path ]

pilrcui-L LANGUAGE ] file.rcp  

WARNING

The information in this man page is an extract from the full documentation of the PalmOS resource compiler, and is limited to the meaning of the options.

For complete documentation on the pilrc and pilrcui programs, please see the HTML documentation included in this package.  

DESCRIPTION

pilrc takes the following list of command line options:
-L LANGUAGE
Generate resource files for target language, LANGUAGE.
-I INCLUDE PATH
Search INCLUDE PATH when looking for include or bitmap files.

NOTE: multiple paths be repeating the -I option.

-D MACRO[=VAL]
Define a pre-processor symbol with an optional value. The macros defined with the -D option can be referenced in #ifdef statements in the resource file for conditional compilation.

NOTE: if no value is specified, the symbol will given the value of 1.

-R RESFILE
Output a .res file specifying all the resources emitted by PilRC.
-H INCLUDE PATH
Output a .h file containing auto-generated resource item IDs for resource items that were defined without an ID previously.

NOTE: If -H is not specified then undefined IDs are considered errors.

-ro
Output a single .ro file in PRC format containing all the generated resources, instead of a collection of .bin files.
-q
Less noisy output, for you minimalists.
-V
Generate M$ (VS-style) warning/error output (default is GNU-style).
-Fh
Use Hebrew font widths for AUTO width calculations.
-Fj
Use Japanese font widths for AUTO width calculations.
-F5
Use Chinese (Big5) font widths for AUTO width calculations.
-Fg
Use Chinese (GB) font widths for AUTO width calculations.
-Fkm
Use Korean font widths for AUTO width calculations (Hanme font)
-Fkt
Use Korean font widths for AUTO width calculations (Hantip font)
-allowEditID
Allow the use of ``edit menu'' ID values (10000-10007 inclusive).
-LE32
Generate Little Endian 32 bits compatible resources (ARM, NT)
-o OUTPUT-PATH
Alternative way of specifying an output path (below).
file.rcp
Input file describing the resources to be emitted.
output path
Directory where .bin files should be generated, or name of the file to generate containing all the generated resources.
 

File Generation

The resources generated are output as a collection of .bin files or as resources within a PRC file, depending on whether -ro is given:
*
Without -ro, each resource is written as a separate file in the output path directory. Each output filename is constructed by appending the hexcode resource ID and ``.bin'' to the four character resource type.
*
With -ro, the resources are written to a single file, with the name given by the output path. The extension ``.ro'' is added if the name has no extension. If no output path has been given, a filename is constructed from the input filename by replacing ``.rcp'' with ``.ro'' (or appending ``.ro'' if the input filename does not end in ``.rcp'').
 

Examples

    pilrc myprogram.rcp
    pilrc -I ../resources -L FRENCH myprogram.rcp
    pilrc -I ../resources -L BIG5 -F5 -R myprogram.res myprogram.rcp output
    pilrc -ro -o myresoures.ro myprogram.rcp
    pilrc -ro myprogram.rcp


 

Resource Files

The following describes some basic characteristics of resource files. For more complete information, see the HTML documentation included with this package:  

Resource Types


.i identifier
example: kFoo
.c character
example: ``O'' (may contain normal C style character escapes)
.s string
example: ``Click Me'' (may contain normal C style character escapes)
.ss multi line string
PilRC will concatenate strings on separate lines

example: ``Now is the time for all good '' \
         ``men to come and aid of their country''

.n number
defined constant or simple arithmetic expression. Valid operators are ``+'', ``-'', ``*'' and ``/''. Precedence is left to right, unless changed with the use of parenthesis. NOTE: Math calculations are integer based. example:

    23
    12+3+1
    12*(2+3)



.p position co-ordinate
may be a number, expression or one of the following keywords.

AUTO
Automatic width or height. Value is computed based on the text in the item.
CENTER
Centers the item either horizontally or vertically.
CENTER@<coord.n>
Centers the item at the co-ordinate following.
RIGHT@<coord.n>
Aligns the item at the right co-ordinate following.
BOTTOM@<coord.n>
Aligns the item at the bottom co-ordinate following.
PREVLEFT
Previous items left co-ordinate.
PREVRIGHT
Previous items right co-ordinate.
PREVTOP
Previous items top co-ordinate.
PREVBOTTOM
Previous items bottom co-ordinate.
PREVWIDTH
 Previous items width.



PREVHEIGHT
Previous items height.

example: PREVRIGHT+2
         CENTER@80/2

NOTE: AUTO and CENTER are not valid in arithmetic expressions.

 

Comments

Single line comments begin with ``//''.

Block comments exist between the ``/*'' and ``*/'' tokens.

Note: ``//'' comments within the definition of objects are treated as errors.  

Include Files

The .rcp file may contain #include directives. This allows a programmer to have one header file for their project containing pre-defined resource IDs. Source code can reference the symbols as can PilRC.

PilRC understands three include file formats.

.h
  #define <Symbol.i><Value.n>



.inc
  <Symbol.i> equ <Value.n>



.java, .jav
  package <PackageName>


  public class <ClassName> {
    public static final short <Symbol.i> = <Value.n>;
  }


Once defined, a symbol can be used in place of any number.

Note: #ifdef derivatives are ignored by PilRC.  

AUTHOR

This man page was generated by Stephen Zander <gibreel@debian.org> for the GNU/Debian Distribution.


 

Index

NAME
SYNOPSIS
WARNING
DESCRIPTION
File Generation
Examples
Resource Files
Resource Types
Comments
Include Files
AUTHOR

This document was created by man2html, using the manual pages.
Time: 12:33:30 GMT, November 06, 2024