Clarify documentation for mkdtemp.

This commit is contained in:
Richard W.M. Jones
2009-06-24 19:57:24 +01:00
parent 0574eab8bc
commit da947eadcf
7 changed files with 41 additions and 21 deletions

View File

@@ -586,7 +586,7 @@ void display_command (const char *cmd)
pod2text ("scrub-freespace - scrub (securely wipe) free space", " scrub-freespace <dir>\n\nThis command creates the directory C<dir> and then fills it\nwith files until the filesystem is full, and scrubs the files\nas for C<scrub_file>, and deletes them.\nThe intention is to scrub any free space on the partition\ncontaining C<dir>.\n\nIt is an interface to the L<scrub(1)> program. See that\nmanual page for more details.");
else
if (strcasecmp (cmd, "mkdtemp") == 0)
pod2text ("mkdtemp - create a temporary directory", " mkdtemp <template>\n\nThis command creates a temporary directory. The\nC<template> parameter should be a full pathname for the\ntemporary directory with the six characters being\n\"XXXXXX\".\n\nFor example: \"/tmp/tmpXXXXXX\" or \"/Temp/tmpXXXXXX\",\nthe second one being suitable for Windows.\n\nThe name of the temporary directory that was created\nis returned.\n\nThe caller is responsible for deleting the temporary\ndirectory and its contents after use.\n\nSee also: L<mkdtemp(3)>");
pod2text ("mkdtemp - create a temporary directory", " mkdtemp <template>\n\nThis command creates a temporary directory. The\nC<template> parameter should be a full pathname for the\ntemporary directory name with the final six characters being\n\"XXXXXX\".\n\nFor example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",\nthe second one being suitable for Windows filesystems.\n\nThe name of the temporary directory that was created\nis returned.\n\nThe temporary directory is created with mode 0700\nand is owned by root.\n\nThe caller is responsible for deleting the temporary\ndirectory and its contents after use.\n\nSee also: L<mkdtemp(3)>");
else
display_builtin_command (cmd);
}

View File

@@ -913,15 +913,18 @@ as necessary. This is like the C<mkdir -p> shell command.
This command creates a temporary directory. The
C<template> parameter should be a full pathname for the
temporary directory with the six characters being
temporary directory name with the final six characters being
"XXXXXX".
For example: "/tmp/tmpXXXXXX" or "/Temp/tmpXXXXXX",
the second one being suitable for Windows.
For example: "/tmp/myprogXXXXXX" or "/Temp/myprogXXXXXX",
the second one being suitable for Windows filesystems.
The name of the temporary directory that was created
is returned.
The temporary directory is created with mode 0700
and is owned by root.
The caller is responsible for deleting the temporary
directory and its contents after use.

View File

@@ -1198,15 +1198,18 @@ This function returns 0 on success or -1 on error.
This command creates a temporary directory. The
C<template> parameter should be a full pathname for the
temporary directory with the six characters being
temporary directory name with the final six characters being
"XXXXXX".
For example: "/tmp/tmpXXXXXX" or "/Temp/tmpXXXXXX",
the second one being suitable for Windows.
For example: "/tmp/myprogXXXXXX" or "/Temp/myprogXXXXXX",
the second one being suitable for Windows filesystems.
The name of the temporary directory that was created
is returned.
The temporary directory is created with mode 0700
and is owned by root.
The caller is responsible for deleting the temporary
directory and its contents after use.

View File

@@ -3539,15 +3539,19 @@ public HashMap<String,String> test0rhashtableerr ()
* <p>
* This command creates a temporary directory. The
* "template" parameter should be a full pathname for the
* temporary directory with the six characters being
* "XXXXXX".
* temporary directory name with the final six characters
* being "XXXXXX".
* <p>
* For example: "/tmp/tmpXXXXXX" or "/Temp/tmpXXXXXX", the
* second one being suitable for Windows.
* For example: "/tmp/myprogXXXXXX" or
* "/Temp/myprogXXXXXX", the second one being suitable for
* Windows filesystems.
* <p>
* The name of the temporary directory that was created is
* returned.
* <p>
* The temporary directory is created with mode 0700 and is
* owned by root.
* <p>
* The caller is responsible for deleting the temporary
* directory and its contents after use.
* <p>

View File

@@ -856,15 +856,18 @@ as necessary. This is like the C<mkdir -p> shell command.
This command creates a temporary directory. The
C<template> parameter should be a full pathname for the
temporary directory with the six characters being
temporary directory name with the final six characters being
"XXXXXX".
For example: "/tmp/tmpXXXXXX" or "/Temp/tmpXXXXXX",
the second one being suitable for Windows.
For example: "/tmp/myprogXXXXXX" or "/Temp/myprogXXXXXX",
the second one being suitable for Windows filesystems.
The name of the temporary directory that was created
is returned.
The temporary directory is created with mode 0700
and is owned by root.
The caller is responsible for deleting the temporary
directory and its contents after use.

View File

@@ -1707,15 +1707,19 @@ class GuestFS:
def mkdtemp (self, template):
u"""This command creates a temporary directory. The
"template" parameter should be a full pathname for the
temporary directory with the six characters being
"XXXXXX".
temporary directory name with the final six characters
being "XXXXXX".
For example: "/tmp/tmpXXXXXX" or "/Temp/tmpXXXXXX", the
second one being suitable for Windows.
For example: "/tmp/myprogXXXXXX" or
"/Temp/myprogXXXXXX", the second one being suitable for
Windows filesystems.
The name of the temporary directory that was created is
returned.
The temporary directory is created with mode 0700 and is
owned by root.
The caller is responsible for deleting the temporary
directory and its contents after use.

View File

@@ -2450,15 +2450,18 @@ manual page for more details.");
"\
This command creates a temporary directory. The
C<template> parameter should be a full pathname for the
temporary directory with the six characters being
temporary directory name with the final six characters being
\"XXXXXX\".
For example: \"/tmp/tmpXXXXXX\" or \"/Temp/tmpXXXXXX\",
the second one being suitable for Windows.
For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
the second one being suitable for Windows filesystems.
The name of the temporary directory that was created
is returned.
The temporary directory is created with mode 0700
and is owned by root.
The caller is responsible for deleting the temporary
directory and its contents after use.