aboutsummaryrefslogtreecommitdiff
path: root/contrib/libxo/xopo/xopo.1
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/libxo/xopo/xopo.1')
-rw-r--r--contrib/libxo/xopo/xopo.177
1 files changed, 77 insertions, 0 deletions
diff --git a/contrib/libxo/xopo/xopo.1 b/contrib/libxo/xopo/xopo.1
new file mode 100644
index 000000000000..c1a9ae8c7041
--- /dev/null
+++ b/contrib/libxo/xopo/xopo.1
@@ -0,0 +1,77 @@
+.\" #
+.\" # Copyright (c) 2015, Juniper Networks, Inc.
+.\" # All rights reserved.
+.\" # This SOFTWARE is licensed under the LICENSE provided in the
+.\" # ../Copyright file. By downloading, installing, copying, or
+.\" # using the SOFTWARE, you agree to be bound by the terms of that
+.\" # LICENSE.
+.\" # Phil Shafer, July 2015
+.\"
+.Dd July 9, 2015
+.Dt XOPO 1
+.Os
+.Sh NAME
+.Nm xopo
+.Nd turn libxo format strings into simplified form
+.Sh SYNOPSIS
+.Nm
+.Op Fl options
+.Sh DESCRIPTION
+The
+.Nm
+utility simplifies libxo format strings into the form used for
+.Xr gettext
+lookups by the
+.Nm libxo
+library.
+Using
+.Nm ,
+users can turn
+.Em .pot
+files generated by
+.Xr xgettext
+into data useful for libxo-enabled applications.
+.Pp
+Since
+.Xr gettext
+uses the string as the key into the message catalog,
+.Nm libxo
+uses a simplified version of the format string that removes
+unimportant field formatting and modifiers, stopping minor formatting
+changes from impacting the expensive translation process.
+A developer
+change such as changing "/%06d" to "/%08d" should not force hand
+inspection of all .po files.
+.Pp
+.Nm
+inspects the input file, looking for lines that begin with "msgid"
+which carry format strings as the remainder of the input line.
+These strings are passed to
+.Nm libxo
+for simplification and the resulting strings are replaced into the
+output stream, allowing
+.Nm
+to operated as a filter.
+.Pp
+.Bl -tag -width "12345678901234567"
+.It Fl "-simplify OR -s <text>"
+Generate the simplified version of a single text string.
+.It Fl "-po OR -f <pofile>"
+Use the given po file for input.
+.It Fl "-help"
+Display this help text
+.It Fl "-output OR -o <file>"
+Write output content to the given file
+.It Fl "-warn OR -W"
+Generate warnings while parsing the format strings
+.It Fl "-version"
+Display version information
+.El
+.Pp
+.Sh EXAMPLE
+.Bd -literal
+ % xopo -f foo.pot -o foo.pot.new
+.Ed
+.Sh SEE ALSO
+.Xr libxo 3 ,
+.Xr xo_format 5