xref: /freebsd/usr.bin/locale/locale.1 (revision 39beb93c3f8bdbf72a61fda42300b5ebed7390c8)
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 November 1, 2005
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 | 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, subject to the environment settings and
50internal status.
51.Pp
52When
53.Nm
54is invoked with the
55.Ar keyword
56arguments, and no options are specified, it will print out the
57values of all keywords specified, using the current locale settings.
58.Pp
59The following options are available:
60.Bl -tag -width indent
61.It Fl a
62Print names of all available locales.
63While looking for locales,
64.Nm
65will respect the
66.Ev PATH_LOCALE
67environment variable, and use it instead of the system's default locale
68directory.
69.It Fl m
70Print names of all available charmaps.
71.It Fl k
72Print the names and values of all selected keywords.
73.It Fl c
74Print the category name for all selected keywords.
75.El
76.Sh IMPLEMENTATION NOTES
77The special
78.Pf ( Fx
79specific) keyword
80.Cm list
81can be used to retrieve the human readable list of all available keywords.
82.Sh EXIT STATUS
83.Ex -std
84.Sh SEE ALSO
85.Xr setlocale 3
86.Sh BUGS
87Since
88.Fx
89does not support
90.Em charmap Ns s
91in their
92.Tn POSIX
93meaning,
94.Nm
95emulates the
96.Fl m
97option using the CODESETs listing of all available locales.
98