cygpath
Prev | Cygwin Utilities | Next

## Name

cygpath — Convert Unix and Windows format paths, or output system path information

## Synopsis

`cygpath` { -d | -m | -u | -w | -t `TYPE` } [-f `FILE`] [-i] [`CONVERSION_OPTION`...] `NAME`...

`cygpath` [-c `HANDLE`]

`cygpath` [-A] { -D | -H | -O | -P | -S | -W | -F `ID` }

`cygpath` -h | -V

## Options

    Output type options:

      -d, --dos             print DOS (short) form of NAMEs (C:\PROGRA~1\)
      -m, --mixed           like --windows, but with regular slashes (C:/WINNT)
      -M, --mode            report on mode of file (currently binmode or textmode)
      -u, --unix            (default) print Unix form of NAMEs (/cygdrive/c/winnt)
      -w, --windows         print Windows form of NAMEs (C:\WINNT)
      -t, --type TYPE       print TYPE form: 'dos', 'mixed', 'unix', or 'windows'

    Path conversion options:

      -a, --absolute        output absolute path
      -l, --long-name       print Windows long form of NAMEs (with -w, -m only,
                            don't mix with -r and -s)
      -r, --root-local      print Windows path with root-local path prefix (\\?\,
                            with -w only)
      -p, --path            NAME is a PATH list (i.e., '/bin:/usr/bin')
      -U, --proc-cygdrive   Emit /proc/cygdrive path instead of cygdrive prefix
                            when converting Windows path to UNIX path.
      -s, --short-name      print DOS (short) form of NAMEs (with -w, -m only,
                            don't mix with -l and -r)
      -C, --codepage CP     print DOS, Windows, or mixed pathname in Windows
                            codepage CP.  CP can be a numeric codepage identifier,
                            or one of the reserved words ANSI, OEM, or UTF8.
                            If this option is missing, cygpath defaults to the
                            character set defined by the current locale.

    System information:

      -A, --allusers        use `All Users' instead of current user for -D, -P
      -D, --desktop         output `Desktop' directory and exit
      -H, --homeroot        output `Profiles' directory (home root) and exit
      -O, --mydocs          output `My Documents' directory and exit
      -P, --smprograms      output Start Menu `Programs' directory and exit
      -S, --sysdir          output system directory and exit
      -W, --windir          output `Windows' directory and exit
      -F, --folder ID       output special folder with numeric ID and exit

    Other options:

      -f, --file FILE       read FILE for input; use - to read from STDIN
      -o, --option          read options from FILE as well (for use with --file)
      -c, --close HANDLE    close HANDLE (for use in captured process)
      -i, --ignore          ignore missing argument
      -h, --help            output usage information and exit
      -V, --version         output version information and exit

## Description

The cygpath program is a utility that converts Windows native filenames to Cygwin POSIX-style pathnames and vice versa. It can be used when a Cygwin program needs to pass a file name to a native Windows program, or expects to get a file name from a native Windows program. Alternatively, cygpath can output information about the location of important system directories in either format.

The `-u` and `-w` options indicate whether you want a conversion to UNIX (POSIX) format (`-u`) or to Windows format (`-w`). Use the `-d` to get DOS-style 8.3 file and path names. The `-m` option will output Windows-style format but with forward slashes instead of backslashes. This option is especially useful in shell scripts, which use backslashes as an escape character.

In combination with the `-w` and `-m` options, you can use the `-l` and `-s` options to use normal (long) or DOS-style 8.3 (short) form. The `-d` option is identical to `-w` and `-s` together.

Note that short DOS-style 8.3 names are not always available. The generation of additional 8.3 filenames is the responsibility of the underlying filesystem. Modern Windows OS allows to switch off 8.3 filename generation and some filesystems never generate 8.3 names. In these cases, using the `-s` option may fail or may be ignored.

In combination with the `-w` option, you can use the `-r` option to generate root-local paths with leading \\?\ prefix. This is especially useful if your path contains path components invalid in DOS paths, for instance file or directory names with trailing dot.

Note that the root-local path prefix is automatically prepended for paths exceeding a length of MAX_PATH (260) bytes.

The `-C` option allows to specify a Windows codepage to print DOS and Windows paths created with one of the `-d`, `-m`, or `-w` options. The default is to use the character set of the current locale defined by one of the internationalization environment variables `LC_ALL`, `LC_CTYPE`, or `LANG`, see the section called “Internationalization”. This is sometimes not sufficient for interaction with native Windows tools, which might expect native, non-ASCII characters in a specific Windows codepage. Console tools, for instance, might expect pathnames in the current OEM codepage, while graphical tools like Windows Explorer might expect pathnames in the current ANSI codepage.

The `-U` option allows to use cygpath to create unambiguous Unix paths pointing outside the Cygwin tree andf thus having no explicit POSIX path. Those paths usually use the cygdrive prefix. However, the cygdrive prefix can be changed by the user, so symbolic links created using the cygdrive prefix are not foolproof. With `-U` cygpath will generate such paths prepended by the virtual `/proc/cygdrive` symbolic link, which will never change, so the created path is safe against changing the cygdrive prefix.

The `-C` option takes a single parameter:

- `ANSI`, to specify the current ANSI codepage

- `OEM`, to specify the current OEM (console) codepage

- `UTF8`, to specify UTF-8.

- A numerical, decimal codepage number, for instance 936 for GBK, 28593 for ISO-8859-3, etc. A full list of supported codepages is listed on the Microsoft MSDN page Code Page Identifiers. A codepage of 0 is the same as if the `-C` hasn't been specified at all.

The `-p` option means that you want to convert a path-style string rather than a single filename. For example, the PATH environment variable is semicolon-delimited in Windows, but colon-delimited in UNIX. By giving `-p` you are instructing cygpath to convert between these formats.

The `-i` option supresses the print out of the usage message if no filename argument was given. It can be used in make file rules converting variables that may be omitted to a proper format. Note that cygpath output may contain spaces (C:\Program Files) so should be enclosed in quotes.

Example 3.7. Example cygpath usage

    #!/bin/sh
    if [ "${1}" = "" ];
    	then
    		XPATH=".";
    	else
    		XPATH="$(cygpath -C ANSI -w "${1}")";
    fi
    explorer $XPATH &

The capital options `-D`, `-H`, `-P`, `-S`, and `-W` output directories used by Windows that are not the same on all systems, for example `-S` might output C:\WINNT\system32 or C:\Windows\System32. The `-H` shows the Windows profiles directory that can be used as root of home. The `-A` option forces use of the "All Users" directories instead of the current user for the `-D`, `-O` and `-P` options. The `-F` outputs other special folders specified by their internal numeric code (decimal or 0x-prefixed hex). For valid codes and symbolic names, see the CSIDL_* definitions in the include file /usr/include/w32api/shlobj.h from package w32api. The current valid range of codes for folders is 0 (Desktop) to 59 (CDBurn area). By default the output is in UNIX (POSIX) format; use the `-w` or `-d` options to get other formats.

Prev | Up | Next
cygcheck | Home | dumper