リナックスコマンド

getcwdのヘルプ・マニュアル

日本語 英語

• help
• man

getcwd --help

man getcwd

GETCWD(3) Linux Programmer’s Manual GETCWD(3) 名前 getcwd, getwd, get_current_dir_name - カレントワーキングディレクトリ名 の取得 書式 #include char *getcwd(char *buf, size_t size); char *getwd(char *buf); char *get_current_dir_name(void); glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照): getcwd(): _BSD_SOURCE || _XOPEN_SOURCE >= 500 get_current_dir_name(): _GNU_SOURCE 説明 これらの関数は、呼び出したプロセスのカレントワーキングディレクトリの 絶 対 パ ス 名 (absolute pathname) が入った文字列を返す。返される文字列は NULL で終端される。パス名は関数の結果として返され、引数 buf がある場 合 は buf 経由でも返される。 getcwd() 関数はカレントワーキングディレクトリの絶対パス名を buf で示さ れた size 長の配列にコピーする。 終端の NULL バイトも含めた、カレントワーキングディレクトリの絶対パス 名 の 長さが size バイトを超えている場合は、返り値として NULL が返り errno に ERANGE がセットされる。アプリケーションはこのエラーをチェックし、 必 要に応じてより長いバッファを用意すべきである。 POSIX.1-2001 標準の拡張として、 Linux (libc4, libc5, glibc) では buf が NULL の場合、 getcwd() は必要なバッファを malloc(3) を用いて動的に割 り 当てる。この場合、 size が 0 の場合を除き、バッファの長さは size となる 。 size が 0 の場合には必要な大きさが確保される。呼び出し側で、返された バッファを free(3) すべきである。 get_current_dir_name() はカレントワーキングディレクトリの絶対パス名を収 めるのに十分な大きさの配列を malloc(3) で獲得する。環境変数 PWD が設 定 さ れておりその値が正しければ、その値が返される。呼び出し側で、返された バッファを free(3) すべきである。 getwd() は malloc(3) によるメモリ獲得を一切行なわない。 buf 引数は少 な く とも PATH_MAX バイトの長さを持つ配列へのポインタである必要がある。終 端の NULL バイトも含めた、カレントワーキングディレクトリの絶対パス名 の 長さが PATH_MAX バイトを超えている場合、 NULL が返され、 errno に ENAM- ETOOLONG が設定される。 (システムによっては、 PATH_MAX は必ずしもコンパ イ ル時に決まる定数ではない点に注意すること。また、ファイルシステムに依 存する場合もある。 pathconf(3) を参照。) 移植性とセキュリティ上の理由か ら、 getwd() の利用は推奨されない。 返り値 成 功すると、これらの関数はカレントワーキングディレクトリの絶対パス名が 入った文字列へのポインタを返す。 getcwd() と getwd() の場合、返り 値 は buf と同じ値になる。 失敗した場合、これらの関数は NULL を返し、 errno にエラーを示す値を設定 する。 buf が指す配列の内容は未定義である。 エラー EACCES ファイル名の構成要素に対する読み込みあるいは検索の権限がない。 EFAULT buf が不正なアドレスを指している。 EINVAL size 引数が 0 かつ、 buf 引数が NULL ポインタでない。 EINVAL getwd(): buf が NULL である。 ENAMETOOLONG getwd(): 絶対パス名が入った NULL 終端された 文 字 列 の 長 さ が PATH_MAX バイトを超えている。 ENOENT カレントワーキングディレクトリが削除されている。 ERANGE size 引数の値がワーキングディレクトリの絶対パス名の長さより小さ い。長さには文字列の終端バイトも含まれる。より大きい配列を確保し てもう一度実行する必要がある。 準拠 getcwd() は POSIX.1-2001 に準拠している。 POSIX.1-2001 は、 buf が NULL の場合の getcwd() の動作を規定しないままとしている。 getwd() は POSIX.1-2001 に存在しているが、「過去の名残(LEGACY)」とさ れ て い る。 POSIX.1-2008 では、 getwd() の仕様が削除されている。代わりに getcwd() を使うこと。 POSIX.1-2001 は getwd() に関するエラーを定義し て いない。 get_current_dir_name() は GNU 拡張である。 注意 Linux では (2.1.92 以降)、 getcwd() はシステムコールである。古いシステ ムでは /proc/self/cwd を参照する。システムコールも proc ファイルシス テ ム もない場合、一般的な実装が呼び出される。この場合においてのみ、(Linux では) この関数は EACCES で失敗する可能性がある。 これらの関数はしばしばカレントワーキングディレクトリの位置を保存し、 後 で 戻ってくるために利用される。未使用のファイルディスクリプタが十分ある 場合は、現在のディレクトリ (".") を開いて fchdir(2) を呼び出すほうが 普 通は高速で信頼性がある。特に Linux 以外のプラットフォームの場合はそうで ある。 関連項目 chdir(2), fchdir(2), open(2), unlink(2), free(3), malloc(3) GNU 2009-03-31 GETCWD(3)

GETCWD(3) Linux Programmer’s Manual GETCWD(3) NAME getcwd, getwd, get_current_dir_name - Get current working directory SYNOPSIS #include char *getcwd(char *buf, size_t size); char *getwd(char *buf); char *get_current_dir_name(void); Feature Test Macro Requirements for glibc (see feature_test_macros(7)): getcwd(): _BSD_SOURCE || _XOPEN_SOURCE >= 500 get_current_dir_name(): _GNU_SOURCE DESCRIPTION These functions return a null-terminated string containing an absolute pathname that is the current working directory of the calling process. The pathname is returned as the function result and via the argument buf, if present. The getcwd() function copies an absolute pathname of the current work- ing directory to the array pointed to by buf, which is of length size. If the length of the absolute pathname of the current working direc- tory, including the terminating null byte, exceeds size bytes, NULL is returned, and errno is set to ERANGE; an application should check for this error, and allocate a larger buffer if necessary. As an extension to the POSIX.1-2001 standard, Linux (libc4, libc5, glibc) getcwd() allocates the buffer dynamically using malloc(3) if buf is NULL. In this case, the allocated buffer has the length size unless size is zero, when buf is allocated as big as necessary. The caller should free(3) the returned buffer. get_current_dir_name() will malloc(3) an array big enough to hold the absolute pathname of the current working directory. If the environment variable PWD is set, and its value is correct, then that value will be returned. The caller should free(3) the returned buffer. getwd() does not malloc(3) any memory. The buf argument should be a pointer to an array at least PATH_MAX bytes long. If the length of the absolute pathname of the current working directory, including the ter- minating null byte, exceeds PATH_MAX bytes, NULL is returned, and errno is set to ENAMETOOLONG. (Note that on some systems, PATH_MAX may not be a compile-time constant; furthermore, its value may depend on the file system, see pathconf(3).) For portability and security reasons, use of getwd() is deprecated. RETURN VALUE On success, these functions return a pointer to a string containing the pathname of the current working directory. In the case getcwd() and getwd() this is the same value as buf. On failure, these functions return NULL, and errno is set to indicate the error. The contents of the array pointed to by buf are undefined on error. ERRORS EACCES Permission to read or search a component of the filename was denied. EFAULT buf points to a bad address. EINVAL The size argument is zero and buf is not a null pointer. EINVAL getwd(): buf is NULL. ENAMETOOLONG getwd(): The size of the null-terminated absolute pathname string exceeds PATH_MAX bytes. ENOENT The current working directory has been unlinked. ERANGE The size argument is less than the length of the absolute path- name of the working directory, including the terminating null byte. You need to allocate a bigger array and try again. CONFORMING TO getcwd() conforms to POSIX.1-2001. Note however that POSIX.1-2001 leaves the behavior of getcwd() unspecified if buf is NULL. getwd() is present in POSIX.1-2001, but marked LEGACY. POSIX.1-2008 removes the specification of getwd(). Use getcwd() instead. POSIX.1-2001 does not define any errors for getwd(). get_current_dir_name() is a GNU extension. NOTES Under Linux, the function getcwd() is a system call (since 2.1.92). On older systems it would query /proc/self/cwd. If both system call and proc file system are missing, a generic implementation is called. Only in that case can these calls fail under Linux with EACCES. These functions are often used to save the location of the current working directory for the purpose of returning to it later. Opening the current directory (".") and calling fchdir(2) to return is usually a faster and more reliable alternative when sufficiently many file descriptors are available, especially on platforms other than Linux. SEE ALSO chdir(2), fchdir(2), open(2), unlink(2), free(3), malloc(3) COLOPHON This page is part of release 3.22 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. GNU 2009-03-31 GETCWD(3)