Import translated manuals from JM CVS Repository.

[linuxjm/jm.git] / manual / LDP_man-pages / draft / man3 / wordexp.3

.\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
.\" USA.
.\"
.\" Japanese Version Copyright (c) 2004 Yuichi SATO
.\"         all rights reserved.
.\" Translated Sun Sep 12 05:05:19 JST 2004
.\"         by Yuichi SATO <ysato444@yahoo.co.jp>
.\"
.TH WORDEXP 3 2008-07-14  "" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O wordexp, wordfree \- perform word expansion like a posix-shell
wordexp, wordfree \- posix ¥·¥§¥ë¤Î¤è¤¦¤Ëñ¸ì¤ÎŸ³«¤ò¹Ô¤¦
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.B "#include <wordexp.h>"
.sp
.BI "int wordexp(const char *" s ", wordexp_t *" p ", int " flags );
.sp
.BI "void wordfree(wordexp_t *" p );
.sp
.in -4n
.\"O Feature Test Macro Requirements for glibc (see
.\"O .BR feature_test_macros (7)):
glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
.RB ( feature_test_macros (7)
»²¾È):
.in
.sp
.BR wordexp (),
.BR wordfree ():
_XOPEN_SOURCE
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O The function
.\"O .BR wordexp ()
.\"O performs a shell-like expansion of the string
.\"O .I s
.\"O and returns the result in the structure pointed to by
.\"O .IR p .
´Ø¿ô
.BR wordexp ()
¤Ï¥·¥§¥ë¤Î¤è¤¦¤Ëʸ»úÎó
.I s
¤òŸ³«¤·¡¢
.I p
¤Ç»Ø¤·¼¨¤¹¹½Â¤ÂΤ˷ë²Ì¤òÊÖ¤¹¡£
.\"O The data type
.\"O .I wordexp_t
.\"O is a structure that at least has the fields
.\"O .IR we_wordc ,
.\"O .IR we_wordv ,
.\"O and
.\"O .IR we_offs .
¥Ç¡¼¥¿·¿
.I wordexp_t
¤Ï¾¯¤Ê¤¯¤È¤â¥Õ¥£¡¼¥ë¥É
.IR we_wordc ,
.IR we_wordv ,
.I we_offs
¤ò»ý¤Ä¹½Â¤ÂΤǤ¢¤ë¡£
.\"O The field
.\"O .I we_wordc
.\"O is a
.\"O .I size_t
.\"O that gives the number of words in the expansion of
.\"O .IR s .
¥Õ¥£¡¼¥ë¥É
.I we_wordc
¤Ï
.I size_t
¤Ç¤¢¤ê¡¢
.I s
¤òŸ³«¤·¤¿·ë²Ì¤Ëñ¸ì¤¬¤¤¤¯¤Ä¤¢¤ë¤«¤òɽ¤¹¡£
.\"O The field
.\"O .I we_wordv
.\"O is a
.\"O .I char **
.\"O that points to the array of words found.
¥Õ¥£¡¼¥ë¥É
.I we_wordv
¤Ï
.I char **
¤Ç¤¢¤ê¡¢¸«¤Ä¤«¤Ã¤¿Ã±¸ì¤ÎÇÛÎó¤ò»Ø¤·¼¨¤¹¡£
.\"O The field
.\"O .I we_offs
.\"O of type
.\"O .I size_t
.\"O is sometimes (depending on
.\"O .IR flags ,
.\"O see below) used to indicate the number of initial elements in the
.\"O .I we_wordv
.\"O array that should be filled with NULLs.
.I size_t
·¿¤Î¥Õ¥£¡¼¥ë¥É
.I we_offs
¤Ï¡¢
.I we_wordv
ÇÛÎó¤Ë¤¢¤ë½é´üÍ×ÁǤΤ¦¤Á¤¤¤¯¤Ä¤¬
NULL ¤ÇËä¤á¤é¤ì¤ë¤Ù¤­¤«¤òɽ¤¹¤Î¤Ë»È¤ï¤ì¤¿¤ê¤¹¤ë
.RI ( flags
¤Ë¤è¤ê·èÄꤵ¤ì¤ë¡£²¼µ­¤ò»²¾È¡£)¡£
.LP
.\"O The function
.\"O .BR wordfree ()
.\"O frees the allocated memory again.
.\"O More precisely, it does not free
.\"O its argument, but it frees the array
.\"O .I we_wordv
.\"O and the strings that points to.
´Ø¿ô
.BR wordfree ()
¤Ï³ä¤êÅö¤Æ¤¿¥á¥â¥ê¤òºÆÅÙ²òÊü¤¹¤ë¡£
¤è¤êÀµ³Î¤Ë¤¤¤¦¤È¡¢¤³¤Î´Ø¿ô¤Ï¤½¤Î°ú¤­¿ô¤ò²òÊü¤¹¤ë¤Î¤Ç¤Ï¤Ê¤¯¡¢
ÇÛÎó
.I we_wordv
¤È¤½¤ì¤¬»Ø¤·¼¨¤¹Ê¸»úÎó¤ò²òÊü¤¹¤ë¡£
.\"O .SS "The string argument"
.SS "ʸ»úÎó°ú¤­¿ô"
.\"O Since the expansion is the same as the expansion by the shell (see
.\"O .BR sh (1))
.\"O of the parameters to a command, the string
.\"O .I s
.\"O must not contain characters that would be illegal in shell command
.\"O parameters.
.\"O In particular, there must not be any unescaped
.\"O newline or |, &, ;, <, >, (, ), {, } characters
.\"O outside a command substitution or parameter substitution context.
¤³¤ÎŸ³«¤Ï¥·¥§¥ë¤Ë¤è¤ë¥³¥Þ¥ó¥É¤Î¥Ñ¥é¥á¡¼¥¿¤ÎŸ³«
.RB ( sh (1)
¤ò»²¾È) ¤ÈƱ¤¸¤Ç¤¢¤ë¤Î¤Ç¡¢Ê¸»úÎó
.I s
¤Ï¥·¥§¥ë¥³¥Þ¥ó¥É¥Ñ¥é¥á¡¼¥¿¤ÇÉÔÀµ¤È¤µ¤ì¤ëʸ»ú¤ò´Þ¤ó¤Ç¤Ï¤Ê¤é¤Ê¤¤¡£
Æä˥¨¥¹¥±¡¼¥×¤µ¤ì¤Æ¤¤¤Ê¤¤²þ¹Ô¡¢|, &, ;, <, >, (, ), {, } ʸ»ú¤ò
¥³¥Þ¥ó¥ÉÃÖ´¹¤ä¥Ñ¥é¥á¡¼¥¿ÃÖ´¹¤Î¾ìḬ̀ʳ°¤Ë´Þ¤á¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
.LP
.\"O If the argument
.\"O .I s
.\"O contains a word that starts with an unquoted comment character #,
.\"O then it is unspecified whether that word and all following words
.\"O are ignored, or the # is treated as a non-comment character.
°ú¤­¿ô
.I s
¤Ë¥¯¥©¡¼¥È¤·¤Æ¤¤¤Ê¤¤¥³¥á¥ó¥Èʸ»ú # ¤Ç»Ï¤Þ¤ëñ¸ì¤¬´Þ¤Þ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ë¤Ï¡¢
¤½¤Îñ¸ì¤È¤½¤ì°Ê¹ß¤Îñ¸ì¤¬Ìµ»ë¤µ¤ì¤ë¤«¡¢
¤½¤ì¤È¤â # ¤¬¥³¥á¥ó¥Èʸ»ú¤È¤·¤Æ°·¤ï¤Ê¤¤¤«¤Ï¡¢µ¬Äꤵ¤ì¤Æ¤¤¤Ê¤¤¡£
.\"O .SS "The expansion"
.SS "Ÿ³«"
.\"O The expansion done consists of the following stages:
.\"O tilde expansion (replacing ~user by user's home directory),
.\"O variable substitution (replacing $FOO by the value of the environment
.\"O variable FOO), command substitution (replacing $(command) or \`command\`
.\"O by the output of command), arithmetic expansion, field splitting,
.\"O wildcard expansion, quote removal.
¼Â¹Ô¤µ¤ì¤ëŸ³«¤Ï¡¢°Ê²¼¤ÎÃʳ¬¤Ç¹½À®¤µ¤ì¤ë:
¥Á¥ë¥ÀŸ³« (~user ¤ò user ¤Î¥Û¡¼¥à¥Ç¥£¥ì¥¯¥È¥ê¤ËÃÖ¤­´¹¤¨¤ë)¡¢
ÊÑ¿ôŸ³« ($FOO ¤ò´Ä¶­ÊÑ¿ô FOO ¤ÎÃͤËÃÖ¤­´¹¤¨¤ë)¡¢
¥³¥Þ¥ó¥ÉŸ³« ($(command) ¤Þ¤¿¤Ï \`command\` ¤ò command ¤Î½ÐÎϤÇÃÖ¤­´¹¤¨¤ë)¡¢
»»½ÑŸ³«¡¢¥Õ¥£¡¼¥ë¥Éʬ³ä¡¢¥ï¥¤¥ë¥É¥«¡¼¥ÉŸ³«¡¢¥¯¥©¡¼¥È¤Î½üµî¡£
.LP
.\"O The result of expansion of special parameters
.\"O ($@, $*, $#, $?, $\-, $$, $!, $0) is unspecified.
Æüì¤Ê¥Ñ¥é¥á¡¼¥¿ ($@, $*, $#, $?, $\-, $$, $!, $0) ¤Î
Ÿ³«·ë²Ì¤Ïµ¬Äꤵ¤ì¤Æ¤¤¤Ê¤¤¡£
.LP
.\"O Field splitting is done using the environment variable $IFS.
.\"O If it is not set, the field separators are space, tab and newline.
¥Õ¥£¡¼¥ë¥Éʬ³ä¤Ï´Ä¶­ÊÑ¿ô $IFS ¤òÍѤ¤¤Æ¹Ô¤ï¤ì¤ë¡£
¤³¤Î´Ä¶­ÊÑ¿ô¤¬ÀßÄꤵ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢
¥Õ¥£¡¼¥ë¥É¶èÀÚ¤êʸ»ú¤Ï¥¹¥Ú¡¼¥¹¡¦¥¿¥Ö¡¦²þ¹Ô¤Ç¤¢¤ë¡£
.\"O .SS "The output array"
.SS "½ÐÎϤµ¤ì¤ëÇÛÎó"
.\"O The array
.\"O .I we_wordv
.\"O contains the words found, followed by a NULL.
ÇÛÎó
.I we_wordv
¤Ï¸«¤Ä¤«¤Ã¤¿Ã±¸ì¤ò¤ò´Þ¤ß¡¢ºÇ¸å¤Ë NULL ¤¬Â³¤¯¡£
.\"O .SS "The flags argument"
.\"O The
.\"O .I flag
.\"O argument is a bitwise inclusive OR of the following values:
.SS "flags °ú¤­¿ô"
.I flags
°ú¤­¿ô¤Ï°Ê²¼¤ÎÃͤΥӥåÈÊñ´ÞŪ OR ¤Ç¤¢¤ë:
.TP
.B WRDE_APPEND
.\"O Append the words found to the array resulting from a previous call.
¸«¤Ä¤«¤Ã¤¿Ã±¸ì¤òÁ°²ó¤Î¸Æ¤Ó½Ð¤··ë²Ì¤ÎÇÛÎó¤ËÄɲ乤롣
.TP
.B WRDE_DOOFFS
.\"O Insert
.\"O .I we_offs
.\"O initial NULLs in the array
.\"O .IR we_wordv .
.\"O (These are not counted in the returned
.\"O .IR we_wordc .)
½é´ü¾õÂ֤Ǥ¢¤ë
.I we_offs
¸Ä¤Î NULL ¤òÇÛÎó
.I we_wordv
¤ËÁÞÆþ¤¹¤ë (¤³¤ì¤é¤ÏÊÖ¤µ¤ì¤ë
.I we_wordc
¤Ë¤Ï¥«¥¦¥ó¥È¤µ¤ì¤Ê¤¤)¡£
.TP
.B WRDE_NOCMD
.\"O Don't do command substitution.
¥³¥Þ¥ó¥ÉÃÖ´¹¤ò¹Ô¤ï¤Ê¤¤¡£
.TP
.B WRDE_REUSE
.\"O The argument
.\"O .I p
.\"O resulted from a previous call to
.\"O .BR wordexp (),
.\"O and
.\"O .BR wordfree ()
.\"O was not called.
.\"O Reuse the allocated storage.
°ú¤­¿ô
.I p
¤ÏÁ°²ó¤Î
.BR wordexp ()
¤Î¸Æ¤Ó½Ð¤··ë²Ì¤Ç¤¢¤ê¡¢
.BR wordfree ()
¤¬ (¤Þ¤À) ¸Æ¤Ó½Ð¤µ¤ì¤Ê¤¤¡£
³ä¤êÅö¤Æ¤é¤ì¤¿Îΰè¤òºÆÍøÍѤ¹¤ë¡£
.TP
.B WRDE_SHOWERR
.\"O Normally during command substitution
.\"O .I stderr
.\"O is redirected to
.\"O .IR /dev/null .
Ä̾ï¤Ï¥³¥Þ¥ó¥ÉÃÖ´¹¤Î¤È¤­¤Ë
.I stderr
¤¬
.I /dev/null
¤Ë¥ê¥À¥¤¥ì¥¯¥È¤µ¤ì¤ë¡£
.\"O This flag specifies that
.\"O .I stderr
.\"O is not to be redirected.
¤³¤Î¥Õ¥é¥°¤Ï
.I stderr
¤ò¥ê¥À¥¤¥ì¥¯¥È¤·¤Ê¤¤¤è¤¦¤Ë»ØÄꤹ¤ë¡£
.TP
.B WRDE_UNDEF
.\"O Consider it an error if an undefined shell variable is expanded.
̤ÄêµÁ¤Î¥·¥§¥ëÊÑ¿ô¤òŸ³«¤·¤è¤¦¤È¤·¤¿¾ì¹ç¤Ë¡¢¥¨¥é¡¼¤È¤·¤Æ°·¤¦¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O In case of success 0 is returned.
.\"O In case of error
.\"O one of the following five values is returned.
À®¸ù¤·¤¿¾ì¹ç¤Ï 0 ¤¬ÊÖ¤µ¤ì¤ë¡£
¥¨¥é¡¼¤Î¾ì¹ç¤Ï°Ê²¼¤Î 5 ¤Ä¤ÎÃͤΤ¦¤Á¤Î 1 ¤Ä¤¬ÊÖ¤µ¤ì¤ë¡£
.TP
.B WRDE_BADCHAR
.\"O Illegal occurrence of newline or one of |, &, ;, <, >, (, ), {, }.
²þ¹Ô¤Þ¤¿¤Ï |, &, ;, <, >, (, ), {, } ¤Î¤¦¤Á¤Î 1 ¤Ä¤¬ÉÔÀµ¤Ë½Ð¸½¤·¤¿¡£
.TP
.B WRDE_BADVAL
.\"O An undefined shell variable was referenced, and the
.\"O .B WRDE_UNDEF
.\"O flag
.\"O told us to consider this an error.
̤ÄêµÁ¤Î¥·¥§¥ëÊÑ¿ô¤¬»²¾È¤µ¤ì¡¢¤«¤Ä
.B WRDE_UNDEF
¥Õ¥é¥°¤Ç¤³¤ì¤ò¥¨¥é¡¼¤È¤·¤Æ°·¤¦¤è¤¦¤Ë»Ø¼¨¤µ¤ì¤Æ¤¤¤ë¡£
.TP
.B WRDE_CMDSUB
.\"O Command substitution occurred, and the
.\"O .B WRDE_NOCMD
.\"O flag told us to consider this an error.
¥³¥Þ¥ó¥ÉÃÖ´¹¤¬µ¯¤³¤ê¡¢¤«¤Ä
.B WRDE_NOCMD
¥Õ¥é¥°¤Ç¤³¤ì¤ò¥¨¥é¡¼¤È¤·¤Æ°·¤¦¤è¤¦¤Ë»Ø¼¨¤µ¤ì¤Æ¤¤¤ë¡£
.TP
.B WRDE_NOSPACE
.\"O Out of memory.
¥á¥â¥ê¤¬Â­¤ê¤Ê¤¤¡£
.TP
.B WRDE_SYNTAX
.\"O Shell syntax error, such as unbalanced parentheses or
.\"O unmatched quotes.
Âбþ¤¹¤ë³ç¸Ì¤¬¤Ê¤¤¡¢¥¯¥©¡¼¥È¤¬¹çÃפ·¤Ê¤¤¤È¤¤¤Ã¤¿¡¢
¥·¥§¥ë¤Î½ñ¼°¥¨¥é¡¼¡£
.\"O .SH VERSIONS
.SH ¥Ð¡¼¥¸¥ç¥ó
.\"O .BR wordexp ()
.\"O and
.\"O .BR wordfree ()
.\"O are provided in glibc since version 2.1.
.BR wordexp ()
¤È
.BR wordfree ()
¤Ï¡¢¥Ð¡¼¥¸¥ç¥ó 2.1 °Ê¹ß¤Î glibc ¤ÇÄ󶡤µ¤ì¤Æ¤¤¤ë¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
POSIX.1-2001.
.\"O .SH EXAMPLE
.SH Îã
.\"O The output of the following example program
.\"O is approximately that of "ls [a-c]*.c".
°Ê²¼¤Î¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Î½ÐÎϤϤÀ¤¤¤¿¤¤ "ls [a-c]*.c" ¤ÈƱ¤¸¤Ë¤Ê¤ë¡£
.LP
.nf
#include <stdio.h>
#include <stdlib.h>
#include <wordexp.h>

int
main(int argc, char **argv)
{
    wordexp_t p;
    char **w;
    int i;

    wordexp("[a-c]*.c", &p, 0);
    w = p.we_wordv;
    for (i = 0; i < p.we_wordc; i++)
        printf("%s\en", w[i]);
    wordfree(&p);
    exit(EXIT_SUCCESS);
}
.fi
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR fnmatch (3),
.BR glob (3)