~ubuntu-branches/ubuntu/gutsy/icu/gutsy

« back to all changes in this revision

Viewing changes to source/tools/pkgdata/pkgdata.8.in

• browse files at revision 3
• compare with another revision
• download diff
• download tarball
• view history from revision 3

Show diffs side-by-side

added

removed

source/tools/pkgdata/pkgdata.8.in

5

5

.\" Copyright (C) 2000-2002 IBM, Inc. and others.

6

6

.\"

7

7

.\" Manual page by Yves Arrouye <yves@realnames.com>.

8

 

.\" Modified by Steven R. Loomis <srl@jtcsv.com>

 

8

.\" Modified by Steven R. Loomis <srl@jtcsv.com>.

9

9

.\"

10

10

.TH PKGDATA 8 "1 March 2002" "ICU MANPAGE" "ICU @VERSION@ Manual"

11

11

.SH NAME

67

67

takes a set of data files and packages them for use by ICU or

68

68

applications that use ICU. The typical reason to package files using

69

69

.B pkgdata

70

 

is to make their distribution easier.

 

70

is to make their distribution easier and their loading by ICU faster

 

71

and less consuming of limited system resources such as file

 

72

descriptors.

 

73

Packaged data also allow applications to be distributed with fewer

 

74

resource files, or even with none at all if they link against the

 

75

packaged data directly.

71

76

.PP

72

77

.B pkgdata

73

78

supports a few different methods of packaging data that serve

102

107

.PP

103

108

The

104

109

.BR static

105

 

packaging mode is similar to dll or library, however it produces a

106

 

static library.  Note that many platforms are not able to dynamically load 

107

 

symbols from static object files, so for this reason 

108

 

.BR udata_setAppData() 

109

 

must be called

110

 

to install this data.  As a convenience, pkgdata will build a C source file

111

 

and a header file. Given a data package named "\fIname\fP", in the output 

112

 

directory will be created \fIname\fR.c and \fIname\fR.h with the single

113

 

function \fBudata_install_\fIname\fB(UErrorCode *err)\fR. Call this function

114

 

once early in the program. The error code returned is that of \fBudata_setAppData()\fP.

115

 

Subsequently, the application can access this data by passing "\fIname\fP" for the "path"

116

 

argument to functions such as \fBures_open()\fP.

117

 

 

118

 

 

 

110

packaging mode is similar to the shared library one except that it

 

111

produces a static library.

 

112

.\" Note that many platforms are not able to

 

113

.\" dynamically load symbols from static object files, so for this reason

 

114

.\" .BR udata_setAppData() 

 

115

.\" must be called

 

116

.\" to install this data. As a convenience, pkgdata will build a C source file

 

117

.\" and a header file. Given a data package named

 

118

.\" .IR name, in the output 

 

119

.\" directory will be created

 

120

.\" .IR name .c

 

121

.\" and

 

122

.\" .IR name .h with the single

 

123

.\" function

 

124

.\" .BR "udata_install_\fcIname\fB(UErrorCode *err)" ,

 

125

.\" where

 

126

.\" .I cname

 

127

.\" is

 

128

.\" .I name

 

129

.\" turned into a valid C identifier.

 

130

.\" The application need to call this function once. The error code returned

 

131

.\" is that of

 

132

.\" .BR udata_setAppData() .

 

133

.\" .PP

 

134

.\" Data pakackaged in a library, whether shared or static, 

 

135

.\" Subsequently, the application can access this data by passing

 

136

.\" .I name for the

 

137

.\" .I path 

 

138

.\" rgument to functions such as

 

139

.\" .BR Bures_open() .

119

140

.PP

120

141

Finally,

121

142

.B pkgdata

132

153

.B pkgdata

133

154

relies on GNU

134

155

.BR make (1)

135

 

to do the packaging, and generates a makefile with rules to build

136

 

and package the correct data.

 

156

to do the packaging, and generates a makefile with rules to build,

 

157

package, install, or clean the appropriate data.

137

158

.SH OPTIONS

138

159

.TP

139

160

.BR "\-h\fP, \fB\-?\fP, \fB\-\-help"

178

199

.BI "\-p\fP, \fB\-\-name" " name"

179

200

Set the packaged file name to

180

201

.IR name .

181

 

This name is also used as the default entry point name.

 

202

This name is also used as the default entry point name after having

 

203

been turned into a valid C identifier.

182

204

.TP

183

205

.BI "\-e\fP, \fB\-\-entrypoint" " name"

184

206

Set the data entry point (used for linking against the data in a

190

212

.TP

191

213

.BI "\-r\fP, \fB\-\-revision" " version"

192

214

Enable versioning of the shared library produced in

193

 

.I dll

 

215

.BR dll ,

 

216

or

 

217

.BR library ,

194

218

mode. The version number has the format

195

219

.I major\fP.\fIminor\fP.\fIpatchlevel

196

220

and all parts except for

242

266

as set by the

243

267

.BI "\-d\fP, \fB\-\-destdir"

244

268

option.

 

269

.SH AUTHORS

 

270

Steven Loomis

 

271

.br

 

272

Yves Arrouye

245

273

.SH VERSION

246

274

@VERSION@

247

275

.SH COPYRIGHT

248

 

Copyright (C) 2000-2001 IBM, Inc. and others.

 

276

Copyright (C) 2000-2002 IBM, Inc. and others.

249

277

 

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1