Skip to content

Commit

Permalink
Add man page for resgen
Browse files Browse the repository at this point in the history
Fix ilasm man page


svn path=/trunk/mono/; revision=76752
  • Loading branch information
migueldeicaza committed May 5, 2007
1 parent 55870eb commit 659d752
Show file tree
Hide file tree
Showing 3 changed files with 120 additions and 3 deletions.
2 changes: 1 addition & 1 deletion man/Makefile.am
Expand Up @@ -2,6 +2,6 @@ man_MANS = mcs.1 mono.1 monostyle.1 mono-config.5 sqlsharp.1 oldmono.1 ilasm.1 \
cert2spc.1 cilc.1 genxs.1 wsdl.1 disco.1 soapsuds.1 makecert.1 \ cert2spc.1 cilc.1 genxs.1 wsdl.1 disco.1 soapsuds.1 makecert.1 \
chktrust.1 setreg.1 sn.1 secutil.1 signcode.1 certmgr.1 monop.1 xsd.1 gacutil.1 \ chktrust.1 setreg.1 sn.1 secutil.1 signcode.1 certmgr.1 monop.1 xsd.1 gacutil.1 \
macpack.1 mkbundle.1 dtd2xsd.1 permview.1 prj2make.1 mono-service.1 mono-shlib-cop.1 \ macpack.1 mkbundle.1 dtd2xsd.1 permview.1 prj2make.1 mono-service.1 mono-shlib-cop.1 \
al.1 mozroots.1 mono-xmltool.1 sgen.1 httpcfg.1 vbnc.1 al.1 mozroots.1 mono-xmltool.1 sgen.1 httpcfg.1 vbnc.1 resgent.1


EXTRA_DIST = $(man_MANS) EXTRA_DIST = $(man_MANS)
12 changes: 10 additions & 2 deletions man/ilasm.1
@@ -1,13 +1,19 @@
.TH "ilasm" 1 .TH "ilasm" 1
.SH NAME .SH NAME
ilasm \- Mono IL assembler ilasm, ilasm2 \- Mono IL assembler
.SH SYNOPSIS .SH SYNOPSIS
.B ilasm .B ilasm
[option] [source-files] [option] [source-files]
.PP
.B ilasm2
[option] [source-files]
.SH DESCRIPTION .SH DESCRIPTION
ilasm is the Mono ILAsm assembler. You can pass one or more options to ilasm is the Mono ILAsm assembler. You can pass one or more options to
drive the compiler, and a set of source files. drive the compiler, and a set of source files.
.PP .PP
Use \fIilasm\fR to generate 1.0 assemblies and use \fIilasm2\fR to
assemble programs that use the 2.0 features (generics).
.PP
The Mono ILAsm assembler accepts options starting with / or - for mosted The Mono ILAsm assembler accepts options starting with / or - for mosted
options. options.
.PP .PP
Expand Down Expand Up @@ -51,8 +57,10 @@ Display information about ilasm
.TP .TP
.B \--version .B \--version
Display ilasm version Display ilasm version
.SH SEE ALSO
.BR mono(1), mcs(1)
.SH COPYRIGHT .SH COPYRIGHT
Copyright (C) 2004 Novell, Inc (http://www.novell.com) Copyright (C) 2004, 2007 Novell, Inc (http://www.novell.com)
.SH MAILING LISTS .SH MAILING LISTS
Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details. Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
.SH WEB SITE .SH WEB SITE
Expand Down
109 changes: 109 additions & 0 deletions man/resgen.1
@@ -0,0 +1,109 @@
.\"
.\" resgen manual page.
.\" (C) 2007 Novell, Inc.
.\" Author:
.\" Miguel de Icaza (miguel@gnu.org)
.\"
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.TH resgen "resgen 1.0"
.SH NAME
resgen, resgen2 \- Mono/CLI Resource Generator
.SH SYNOPSIS
.PP
.B resgen source.ext [dest.ext]
.PP
.B resgen /compile source.ext[,dest.resources] [...]
.PP
.B resgen2
.SH DESCRIPTION
Convert a resource file from one format to another.
.PP
The currently supported formats are text, resources, resx and po.
.TP
.I .txt, .text
.Sp
Used to process text files, the format of the text file is of the
form:
.nf

key=value

.fi
The value argument can contain special characters as long as they are
escaped. The escape sequences currently supported are \\n, \\r, \\t,
\\\\ (to get the escape sequence itself) and with resgen2 unicode
escape sequences are supported with the \\uXXXX escape sequence, where
XXXX is a four digit number.
.Sp
Lines that start with the # or ; character are considered comments and
ignored.
.TP
.I '.resources'
.Sp
This is the binary file format implemented by the
\fISystem.Resources.ResourceReader\fR class, part of mscorlib.dll
.TP
.I '.resx'
.Sp
This is the binary file format implemented by the
\fISystem.Resources.ResXResourceReader\fR class. This class is not
part of mscorlib.dll, this class is part of System.Windows.Forms.
.TP
.I '.po'.
.Sp
PO files are the source files used by the Unix gettext infrastructure
that is typically used to internationalize applications.
.Sp
Lines starting with the '#' character are comment lines.
.Sp
The file contains many instance of strings like this:
.nf

msgid KEY
msgstr VALUE

.fi
The KEY is typically the string to translate and the VALUE is the
translation. On PO files instead of using codes as the KEY (as it is
customary with resource files) the KEY is typically a complete english
message that applications embed in their source code and will be used
as a fallback if no translation resources are used.
.Sp
Since resources are key value pairs, the extended features in PO files
are not supported (plurals and support for N-cases).
.Sp
To learn more about the po file format, use your info browser and
point it to the "(gettext)PO Files" node.
.PP
If the destination file is not specified, source.resources will be
used.
.PP
The /compile option takes a list of .resX or .txt files to convert to
.resources files in one bulk operation, replacing .ext with .resources for
the output file name.
.SH OPTIONS
.TP
.I "-compile"
.Sp
This switch instructs \fIresgen\fR to compile multiple files. It must
appear before any resources are specified on the command line.
.TP
.I "-usesourcepath"
.Sp
This option is only available for \fIresgen2\fR, and it instructs resgen to
resolve relative paths using the directory of the resx file as current
directory.
.SH FILES
This program will load referenced assemblies from the Mono assembly
cache.
.SH MAILING LISTS
Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
.SH WEB SITE
Visit: http://www.mono-project.com for details
.SH SEE ALSO
.BR mcs(1), mono(1), mono-config(5).


0 comments on commit 659d752

Please sign in to comment.