xref: /freebsd/usr.bin/locale/locale.1 (revision 2357939bc239bd5334a169b62313806178dd8f30)
1.\"
2.\" Copyright (c) 2003 Alexey Zelkin <phantom@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd June 20, 2003
29.Dt LOCALE 1
30.Os
31.Sh NAME
32.Nm locale
33.Nd get locale-specific information
34.Sh SYNOPSIS
35.Nm
36.Op Fl a | Fl m
37.Nm
38.Op Fl ck
39.Op Ar keyword ...
40.Sh DESCRIPTION
41The
42.Nm
43utility is supposed to provide most locale specific information to
44the standard output.
45.Pp
46When
47.Nm
48is invoked without arguments, it will print out a summary of the current
49locale environment depending on environment variable settings and
50internal status.
51.Pp
52When
53.Nm
54is invoked with arguments and no options specified, it will print out
55.Em keyword Ns No 's
56value determined using the current locale settings.
57.Pp
58The following options are available:
59.Bl -tag -width indent
60.It Fl a
61Write names of all available locales.
62While looking for locales,
63.Nm
64will respect the
65.Ev PATH_LOCALE
66environment variable, and use it instead of the system's default locale
67directory.
68.It Fl m
69Write names of all available charmaps.
70.It Fl k
71Write the name and value of the selected keywords.
72.It Fl c
73Write the category name for the selected keywords.
74.El
75.Sh IMPLEMENTATION DETAILS
76Special (FreeBSD specific) keyword
77.Ar list
78can be used to retrieve human readable list of available keywords.
79.Sh DIAGNOSTICS
80The
81.Nm
82utility exits 0 on success, and >0 if an error occurs.
83.Sh BUGS
84Since
85.Fx
86does not support
87.Em charmap Ns No s
88in their
89.Em POSIX
90meaning,
91.Nm
92emulates the
93.Ar m
94option via CODESETs listing of all available locales.
95