Editing Open file under cursor

Often a file contains the name of a second file, and you would like to open the second file. Do that by putting the cursor on the file name and typing <code>gf</code>. This tip explains the details of <code>gf</code>.

|<code>gf</code> || open in the same window ("goto file")

|<code><c-w>f</code> || open in a new window (Ctrl-w <code>f</code>)

|<code><c-w>gf</code> || open in a new tab (Ctrl-w <code>gf</code>)

We usually type <code>gf</code> in normal mode in which case Vim has to determine where the file name starts and ends. It does that by taking all characters matching the <code>'isfname'</code> option. Alternatively, you can visually select the file name, then type <code>gf</code> in which case Vim will use the selected text.

With the cursor on a file name, pressing Ctrl-w then <code>f</code> (or Ctrl-f) will open the file in a new window (after a horizontal split). If you want a vertical split, you could next type Ctrl-w <code>L</code> to move the window to the right. Or, you could map a key to perform a vertical "go to file" split (<code>:vertical</code> makes what follows split vertically; <code>:wincmd</code> is a command that is equivalent to pressing Ctrl-w):

When writing a program, it is helpful to set the <code>'path'</code> option to list the directories with your include files. Then you can easily open an include file.

If there are several files in your <code>'path'</code> that match the name under the cursor, <code>gf</code> opens the first, while <code>2gf</code> opens the second, and <code>3gf</code> opens the third, etc.

Instead of just a file name, you may have a name followed by a line number. For example, <code>global.h:123</code> indicates line 123 in file <code>global.h</code>. Instead of a colon, any whitespace and another delimiter character can separate the name and number; the delimiter must not be a character expected in a file name (the <code>'isfname'</code> option must not include the delimiter).

On Windows, the default <code>'isfname'</code> includes a colon. If you do not use drive letters to identify files, you could remove the colon with the command:

|<code>gF</code> || open in the same window

|<code><c-w>F</code> || open in a new window (Ctrl-w <code>F</code>)

|<code><c-w>gF</code> || open in a new tab (Ctrl-w <code>gF</code>)

The {{script|id=2184|text=file:line plugin}} allows you to use combinations of file name and line number, like <code>global.h:123</code>, as an argument to Vim. When you open ''file:line'', the script checks if ''file'' exists and ''line'' is a number. If so, Vim opens ''file'' at the correct ''line'' line number.

With default settings, Vim regards spaces as delimiters (not part of a file name). That means you cannot type <code>gf</code> to open a file if the name contains a space character. However, you can visually select the name (including the spaces), then type <code>gf</code> to open the file. For example, you could position the cursor on the first character of the file name, then press <code>v</code> to start visual selection, then repeatedly press <code>E</code> to move to the end of the next WORD until the whole name is selected, then type <code>gf</code>.

With the default settings, if you put the cursor on the "and" word then type <code>gf</code>, Vim will try to open a file called <code>and</code>. However, you can open the required file by selecting the whole name then typing <code>gf</code>. For example, type <code>^vg_</code> to select the name, then <code>gf</code> to open the file (<code>^</code> jumps to the first nonblank character; <code>v</code> enters visual mode; <code>g_</code> jumps to the last nonblank character).

If you prefer the mouse, depending on your settings, you may be able to select the name with the mouse, then type <code>gf</code>. Before typing <code>gf</code>, check that you are in visual mode (if the status line shows <code>--SELECT--</code>, switch to visual mode by pressing Ctrl-g).

===Adjusting <code>isfname</code>===

On Windows, another approach is to use the 8.3 short path name to avoid spaces. For example, the following tells Vim to look for files in the <code>C:\Documents and Settings\My User Name\My Documents</code> directory:

Double backslashes are required in the <code>:set</code> command to get single backslashes in the value. Alternately, use forward slashes:

Assuming the file <code>abc.txt</code> exists in the <code>$mydir</code> directory, you can put the cursor on the name then type <code>gf</code> to open the file.

If you copy your files to another system using different directories, you can alter the definition of <code>$mydir</code>, for example:

The above used forward slashes for the path delimiter; that should work on all systems. On Windows, you could use backslashes instead, and you can mix back and forward slashes (for example, using backslashes in <code>$mydir</code> and forward slashes in <code>$mydir/abc.txt</code>).

<code>gf</code> or <code><c-w>f</code> or <code><c-w>gf</code>

*Need brief explanation <code>'isfname'</code>.

*Need brief explanation of <code>'path'</code>: meanings of <code>.</code> and <code>,,</code>; how to include space in path.

The plugin {{script|id=229|text=searchInRuntime}} overrides <code>gf</code> and <code>CTRL-W_f</code> to ask which file must be opened if several match. Alternatives for <code>:sp</code> and <code>:vsp</code> are also provided.