Jan: /* File */

2011-11-25T16:45:26Z

File

â† Older revision		Revision as of 16:45, 25 November 2011
Line 6:		Line 6:

	*Note that the output file name is $OUTDIR\filename_portion_of_file.		*Note that the output file name is $OUTDIR\filename_portion_of_file.
	*Use /oname=X switch to change the output name. X may contain variables and can be a fully qualified path or a relative path in which case it will be appended to $OUTDIR set by [[Reference/SetOutPath\|SetOutPath]]. When using this switch, only one file can be specified. If the output name contains spaces, quote the entire parameter, including /oname, as shown in the examples below.		*Use /oname=X switch to change the output name. X may contain variables and can be a fully qualified path or a relative path in which case it will be appended to [[Reference/$OUTDIR\|$OUTDIR]] set by [[Reference/SetOutPath\|SetOutPath]]. When using this switch, only one file can be specified. If the output name contains spaces, quote the entire parameter, including /oname, as shown in the examples below.
	*Wildcards are supported.		*Wildcards are supported.
	If the /r switch is used, matching files and directories are recursively searched for in subdirectories. If just one path segment is specified (e.g. File /r something), the current directory will be recursively searched. If more than one segment is specified (e.g. File /r something\.*), the last path segment will be used as the matching condition and the rest for the directory to search recursively. If a directory name matches, all of its contents is added recursively. Directory structure is preserved.		If the /r switch is used, matching files and directories are recursively searched for in subdirectories. If just one path segment is specified (e.g. File /r something), the current directory will be recursively searched. If more than one segment is specified (e.g. File /r something\.*), the last path segment will be used as the matching condition and the rest for the directory to search recursively. If a directory name matches, all of its contents is added recursively. Directory structure is preserved.

Jan: Created page with "=File= [/nonfatal] [/a] ([/r] [/x file|wildcard [...]] (file|wildcard) [...] | /oname=file.dat infile.dat) Adds file(s) to be extracted to the current output path ($OUTDIR). ..."

2011-11-25T16:44:18Z

Created page with "=File= [/nonfatal] [/a] ([/r] [/x file|wildcard [...]] (file|wildcard) [...] | /oname=file.dat infile.dat) Adds file(s) to be extracted to the current output path ($OUTDIR). ..."

New page

=File=

[/nonfatal] [/a] ([/r] [/x file|wildcard [...]] (file|wildcard) [...] | /oname=file.dat infile.dat)

Adds file(s) to be extracted to the current output path ($OUTDIR).

*Note that the output file name is $OUTDIR\filename_portion_of_file.
*Use /oname=X switch to change the output name. X may contain variables and can be a fully qualified path or a relative path in which case it will be appended to $OUTDIR set by [[Reference/SetOutPath|SetOutPath]]. When using this switch, only one file can be specified. If the output name contains spaces, quote the entire parameter, including /oname, as shown in the examples below.
*Wildcards are supported.
*If the /r switch is used, matching files and directories are recursively searched for in subdirectories. If just one path segment is specified (e.g. File /r something), the current directory will be recursively searched. If more than one segment is specified (e.g. File /r something\*.*), the last path segment will be used as the matching condition and the rest for the directory to search recursively. If a directory name matches, all of its contents is added recursively. Directory structure is preserved.
*Use the /x switch to exclude files or directories.
*If the /a switch is used, the attributes of the file(s) added will be preserved.
*The File command sets the error flag if overwrite mode is set to 'try' and the file could not be overwritten, or if the overwrite mode is set to 'on' and the file could not be overwritten and the user selects ignore.
*If the /nonfatal switch is used and no files are found, a warning will be issued instead of an error.

<highlight-nsis>File something.exe
File /a something.exe
File *.exe
File /r *.dat
File /r data
File /oname=temp.dat somefile.ext
File /oname=$TEMP\temp.dat somefile.ext
File "/oname=$TEMP\name with spaces.dat" somefile.ext
File /nonfatal "a file that might not exist"
File /r /x CVS myproject\*.*
File /r /x *.res /x *.obj /x *.pch source\*.*</highlight-nsis>

'''Note''': when using the ''/r'' switch, both matching directories and files will be searched. This is always done with or without the use of wildcards, even if the given path perfectly matches one directory. That means, the following directory structure:

<highlight-nsis><DIR> something
file.dat
another.dat
<DIR> dir
something
<DIR> dir2
file2.dat
<DIR> another
<DIR> something
readme.txt</highlight-nsis>

with the following File usage:

<highlight-nsis>File /r something</highlight-nsis>

will match the directory named ''something'' on the root directory, the file named ''something'' in the directory named dir and the directory named something in the directory named ''another''. To match only the directory named something on the root directory, use the following:

<highlight-nsis>File /r something\*.*</highlight-nsis>

When adding \*.*, it will be used as the matching condition and ''something'' will be used as the directory to search. When only ''something'' is specified, the current directory will be recursively searched for every and directory named ''something'' and ''another\something'' will be matched.

Reference/File - Revision history

Jan: /* File */

Jan: Created page with "=File= [/nonfatal] [/a] ([/r] [/x file|wildcard [...]] (file|wildcard) [...] | /oname=file.dat infile.dat) Adds file(s) to be extracted to the current output path ($OUTDIR). ..."