usr/src/man/man1/srchtxt.1

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH SRCHTXT 1 "Dec 20, 1996"
   7 .SH NAME
   8 srchtxt \- display contents of, or search for a text string in, message data
   9 bases
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBsrchtxt\fR [\fB-s\fR] [\fB-l\fR \fIlocale\fR] [\fB-m\fR \fImsgfile\fR ,...] [\fItext\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBsrchtxt\fR utility is used to display all the text strings in message
  20 data bases, or to search for a text string in message data bases (see
  21 \fBmkmsgs\fR(1)). These data bases are files in the directory\fB
  22 /usr/lib/locale/\fIlocale\fR/LC_MESSAGES\fR (see \fBsetlocale\fR(3C)), unless a
  23 file name given with the \fB-m\fR option contains a \fB/\fR. The directory
  24 \fBlocale\fR can be viewed as the name of the language in which the text
  25 strings are written. If the \fB-l\fR option is not specified, the files
  26 accessed will be determined by the value of the environment variable
  27 \fBLC_MESSAGES\fR. If \fBLC_MESSAGES\fR is not set, the files accessed will be
  28 determined by the value of the environment variable \fBLANG\fR. If \fBLANG\fR
  29 is not set, the files accessed will be in the directory
  30 \fB/usr/lib/locale//C/LC_MESSAGES \fR, which contains default strings.
  31 .sp
  32 .LP
  33 If no \fItext\fR argument is present, then all the text strings in the files
  34 accessed will be displayed.
  35 .sp
  36 .LP
  37 If the \fB-s\fR option is not specified, the displayed text is prefixed by
  38 message sequence numbers. The message sequence numbers are enclosed in angle
  39 brackets: \fB<\fR\fImsgfile\fR\fB:\fR\fImsgnum\fR\fB>.\fR
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fImsgfile\fR \fR
  44 .ad
  45 .RS 12n
  46 name of the file where the displayed text occurred
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fImsgnum\fR \fR
  53 .ad
  54 .RS 12n
  55 sequence number in \fImsgfile\fR where the displayed text occurred
  56 .RE
  57
  58 .sp
  59 .LP
  60 This display is in the format used by \fBgettxt\fR(1) and \fBgettxt\fR(3C).
  61 .SH OPTIONS
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fB-s\fR\fR
  66 .ad
  67 .RS 14n
  68 Suppress printing of the message sequence numbers of the messages being
  69 displayed.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fB-l\fR\fI locale\fR \fR
  76 .ad
  77 .RS 14n
  78 Access files in the directory \fB/usr/lib/locale/\fIlocale\fR/LC_MESSAGES\fR.
  79 If \fB-m\fR \fImsgfile\fR is also supplied, \fIlOCALE\fR is ignored for
  80 \fImsgfile\fRs containing a \fB/\fR.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fB-m\fR\fI msgfile\fR\fR
  87 .ad
  88 .RS 14n
  89 Access files specified by one or more \fImsgfile\fRs. If \fImsgfile\fR contains
  90 a \fB/\fR character, then \fImsgfile\fR \fIis\fR interpreted as a pathname;
  91 otherwise, it will be assumed to be in the directory determined as described
  92 above. To specify more than one \fImsgfile\fR, separate the file names using
  93 commas.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fItext\fR \fR
 100 .ad
 101 .RS 14n
 102 Search for the text string specified by \fItext\fR and display each one that
 103 matches. \fItext\fR can take the form of a regular expression; see
 104 \fBregexp\fR(5).
 105 .RE
 106
 107 .SH EXAMPLES
 108 .LP
 109 \fBExample 1 \fRUsing \fBsrchtxt\fR
 110 .sp
 111 .LP
 112 If message files have been installed in a locale named \fBfrench\fR by using
 113 \fBmkmsgs\fR(1), then you could display the entire set of text strings in the
 114 \fBfrench\fR locale (\fB/usr/lib/locale/french/LC_MESSAGES/* \fR) by typing:
 115
 116 .sp
 117 .in +2
 118 .nf
 119 example% srchtxt \(mil french
 120 .fi
 121 .in -2
 122 .sp
 123
 124 .LP
 125 \fBExample 2 \fRUsing \fBsrchtxt\fR
 126 .sp
 127 .LP
 128 If a set of error messages associated with the operating system have been
 129 installed in the file \fBUX\fR in the \fBfrench\fR locale
 130 (\fB/usr/lib/locale/french/LC_MESSAGE/UX \fR), then, using the value of the
 131 \fBLANG\fR environment variable to determine the locale to be searched, you
 132 could search that file in that locale for all error messages dealing with files
 133 by typing:
 134
 135 .sp
 136 .in +2
 137 .nf
 138 example% setenv LANG=french; export  LANG
 139 example% srchtxt -m UX "[Ff]ichier"
 140 .fi
 141 .in -2
 142 .sp
 143
 144 .sp
 145 .LP
 146 If \fB/usr/lib/locale/french/LC_MESSAGES/UX \fR contained the following
 147 strings:
 148
 149 .sp
 150 .in +2
 151 .nf
 152 Erreur E/S\en
 153 Liste d'arguments trop longue\en
 154 Fichier inexistant\en
 155 Argument invalide\en
 156 Trop de fichiers ouverts\en
 157 Fichier trop long\en
 158 Trop de liens\en
 159 Argument hors du domaine\en
 160 Identificateur supprim\en
 161 Etreinte fatale\en
 162   .
 163   .
 164   .
 165 .fi
 166 .in -2
 167
 168 .sp
 169 .LP
 170 then the following strings would be displayed:
 171
 172 .sp
 173 .in +2
 174 .nf
 175 <UX:3>Fichier inexistant\en
 176 <UX:5>Trop de fichiers ouverts\en
 177 <UX:6>Fichier trop long\en
 178 .fi
 179 .in -2
 180 .sp
 181
 182 .LP
 183 \fBExample 3 \fRUsing \fBsrchtxt\fR
 184 .sp
 185 .LP
 186 If a set of error messages associated with the operating system have been
 187 installed in the file \fBUX\fR and a set of error messages associated with the
 188 INGRESS data base product have been installed in the file \fBingress\fR, both
 189 in the \fBgerman\fR locale, then you could search for the pattern
 190 \fB[Dd]atei\fR in both the files \fBUX\fR and \fBingress\fR in the \fBgerman\fR
 191 locale by typing:
 192
 193 .sp
 194 .in +2
 195 .nf
 196 example% srchtxt -l german -m UX,ingress "[Dd]atei"
 197 .fi
 198 .in -2
 199 .sp
 200
 201 .SH ENVIRONMENT VARIABLES
 202 .sp
 203 .LP
 204 See \fBenviron\fR(5) for a description of the \fBLC_CTYPE\fR environment
 205 variable that affects the execution of \fBsrchtxt\fR.
 206 .SH FILES
 207 .sp
 208 .ne 2
 209 .na
 210 \fB\fB/usr/lib/locale/C/LC_MESSAGES/* \fR\fR
 211 .ad
 212 .sp .6
 213 .RS 4n
 214 default files created by \fBmkmsgs\fR(1)
 215 .RE
 216
 217 .sp
 218 .ne 2
 219 .na
 220 \fB\fB/usr/lib/locale/locale/LC_MESSAGES/* \fR\fR
 221 .ad
 222 .sp .6
 223 .RS 4n
 224 message files created by \fBmkmsgs\fR(1)
 225 .RE
 226
 227 .SH SEE ALSO
 228 .sp
 229 .LP
 230 \fBexstr\fR(1), \fBgettxt\fR(1), \fBlocale\fR(1), \fBmkmsgs\fR(1),
 231 \fBgettxt\fR(3C), \fBsetlocale\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5),
 232 \fBlocale\fR(5), \fBregexp\fR(5)
 233 .SH DIAGNOSTICS
 234 .sp
 235 .LP
 236 The error messages produced by \fBsrchtxt\fR are intended to be
 237 self-explanatory. They indicate an error in the command line or errors
 238 encountered while searching for a particular locale and/or message file.