components/wxwidgets/man/wxrc.1
author Mike Sullivan <Mike.Sullivan@Oracle.COM>
Wed, 29 Aug 2012 11:05:56 -0700
changeset 957 255465c5756f
parent 262 7e3572caa313
permissions -rw-r--r--
Close of build 04.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
262
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
     1
.\"
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
     2
.\" CDDL HEADER START
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
     3
.\"
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
     4
.\" The contents of this file are subject to the terms of the
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
     5
.\" Common Development and Distribution License (the "License").
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
     6
.\" You may not use this file except in compliance with the License.
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
     7
.\"
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
     8
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
     9
.\" or http://www.opensolaris.org/os/licensing.
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    10
.\" See the License for the specific language governing permissions
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    11
.\" and limitations under the License.
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    12
.\"
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    13
.\" When distributing Covered Code, include this CDDL HEADER in each
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    14
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    15
.\" If applicable, add the following below this CDDL HEADER, with the
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    16
.\" fields enclosed by brackets "[]" replaced with your own identifying
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    17
.\" information: Portions Copyright [yyyy] [name of copyright owner]
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    18
.\"
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    19
.\" CDDL HEADER END
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    20
.\"
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    21
.\" Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    22
.\"
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    23
'\" te
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    24
.TH wxrc 1 "5 Aug 2008" "SunOS 5.11" "User Commands"
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    25
.SH NAME
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    26
wxrc \- compile binary xml resource files
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    27
.SH SYNOPSIS
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    28
.LP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    29
.nf
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    30
\fBwxrc\fR [\fB\fIresource_filename\fR] 
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    31
.fi
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    32
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    33
.LP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    34
.nf
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    35
\fBwxrc\fR [\fB\fIresource_filename\fR] [\fB\fIoptions\fR]... 
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    36
.fi
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    37
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    38
.SH DESCRIPTION
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    39
.LP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    40
The \fBwxrc\fR utility compiles binary xml resource files. It takes one or more file parameters (the input XRC files).
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    41
.SH OPTIONS
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    42
.LP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    43
The following options are supported:
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    44
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    45
\fB-h\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    46
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    47
\fB--help\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    48
Show a help message.
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    49
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    50
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    51
\fB-v\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    52
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    53
\fB--verbose\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    54
Show verbose logging information
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    55
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    56
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    57
\fB-c\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    58
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    59
\fB--cpp-code\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    60
Write C++ source rather than a XRS file
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    61
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    62
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    63
\fB-e\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    64
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    65
\fB--extra-cpp-code\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    66
If used together with -c, generates C++ header file containing class definitions for the windows defined by the XRC file (see special subsection)
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    67
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    68
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    69
\fB-u\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    70
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    71
\fB--uncompressed\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    72
Do not compress XML files (C++ only)
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    73
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    74
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    75
\fB-g\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    76
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    77
\fB--gettext\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    78
Output underscore-wrapped strings that poEdit or gettext can scan. Outputs to stdout, of a file -o is used.
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    79
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    80
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    81
\fB-n\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    82
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    83
\fB--function\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    84
<name>: Specify C++ function name (use with -c)
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    85
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    86
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    87
\fB-o\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    88
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    89
\fB--output\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    90
<filename>: Specify the output file, such as resource .xrs or resource .cpp.
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    91
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    92
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    93
\fB-l\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    94
.TP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    95
\fB--list-of-handlers\fR
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    96
<filename>: Output a list of necessary handlers to this file
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    97
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    98
.SH EXAMPLES
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
    99
.LP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   100
\fBExample 1 \fRCompiling resource .xrc file
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   101
.LP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   102
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   103
.sp
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   104
.in +2
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   105
.nf
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   106
example$ wxrc reource.xrc
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   107
example$ wxrc -o reource.xrs
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   108
.fi
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   109
.in -2
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   110
.sp
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   111
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   112
.LP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   113
\fBExample 2 \fRCompiling resource .cpp file
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   114
.LP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   115
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   116
.sp
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   117
.in +2
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   118
.nf
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   119
example$ wxrc -v -c -o resource.cpp
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   120
.fi
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   121
.in -2
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   122
.sp
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   123
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   124
.SH SEE ALSO
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   125
.LP
7e3572caa313 7031528 move wxGTK to userland
Vladimir Marek <Vladimir.Marek@oracle.com>
parents:
diff changeset
   126
\fBwx-config\fR(1)