xref: /freebsd/usr.bin/locale/locale.1 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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 18, 2012
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.Fl k
39.Ic list
40.Op Ar prefix
41.Nm
42.Op Fl ck
43.Op Ar keyword ...
44.Sh DESCRIPTION
45The
46.Nm
47utility is supposed to provide most locale specific information to
48the standard output.
49.Pp
50When
51.Nm
52is invoked without arguments, it will print out a summary of the current
53locale environment, subject to the environment settings and
54internal status.
55.Pp
56When
57.Nm
58is invoked with the
59.Ar keyword
60arguments, and no options are specified, it will print out the
61values of all keywords specified, using the current locale settings.
62.Pp
63The following options are available:
64.Bl -tag -width indent
65.It Fl a
66Print names of all available locales.
67While looking for locales,
68.Nm
69will respect the
70.Ev PATH_LOCALE
71environment variable, and use it instead of the system's default locale
72directory.
73.It Fl c
74Print the category name for all selected keywords.
75If no keywords are selected, print the category name for all defined
76keywords.
77.It Fl k
78Print the names and values of all selected keywords.
79If no keywords are selected, print the names and values of all defined
80keywords.
81.It Fl m
82Print names of all available charmaps.
83.El
84.Sh IMPLEMENTATION NOTES
85The special
86.Pf ( Fx
87specific) keyword
88.Cm list
89can be used to retrieve the human readable list of all available keywords.
90If so,
91a prefix string can be defined to limit the amount of keywords returned.
92.Sh EXIT STATUS
93.Ex -std
94.Sh SEE ALSO
95.Xr setlocale 3
96.Sh STANDARDS
97The
98.Nm
99utility conforms to
100.St -p1003.1-2004 .
101The
102.Ev LC_CTYPE ,
103.Ev LC_MESSAGES
104and
105.Ev NLSPATH
106environment variables are not interpreted.
107.Sh BUGS
108Since
109.Fx
110does not support
111.Em charmap Ns s
112in their
113.Tn POSIX
114meaning,
115.Nm
116emulates the
117.Fl m
118option using the CODESETs listing of all available locales.
119