usr/src/man/man3gen/mkdirp.3gen

   1 '\" te
   2 .\" Copyright 1989 AT&T. Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH MKDIRP 3GEN "Oct 14, 2003"
   7 .SH NAME
   8 mkdirp, rmdirp \- create or remove directories in a path
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR ... ] \fIfile\fR ... \fB-lgen\fR [ \fIlibrary\fR ... ]
  13 #include <libgen.h>
  14
  15 \fBint\fR \fBmkdirp\fR(\fBconst char *\fR\fIpath\fR, \fBmode_t\fR \fImode\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBrmdirp\fR(\fBchar *\fR\fIdir\fR, \fBchar *\fR\fIdir1\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBmkdirp()\fR function creates all the missing directories in \fIpath\fR
  27 with \fImode\fR. See \fBchmod\fR(2) for the values of \fImode\fR.
  28 .sp
  29 .LP
  30 The \fBrmdirp()\fR function removes directories in path \fIdir\fR. This removal
  31 begins at the end of the path and moves backward toward the root as far as
  32 possible. If an error occurs, the remaining path is stored in \fIdir1\fR.
  33 .SH RETURN VALUES
  34 .sp
  35 .LP
  36 If \fIpath\fR already exists or if a needed directory cannot be created,
  37 \fBmkdirp()\fR returns \fB\(mi1\fR and sets \fBerrno\fR to one of the error
  38 values listed for \fBmkdir\fR(2). It returns zero if all the directories are
  39 created.
  40 .sp
  41 .LP
  42 The \fBrmdirp()\fR function returns \fB0\fR if it is able to remove every
  43 directory in the path. It returns \fB\(mi2\fR if a ``\fB\&.\fR'' or
  44 ``\fB\&..\fR'' is in the path and \fB\(mi3\fR if an attempt is made to remove
  45 the current directory. Otherwise it returns \fB\(mi1\fR\&.
  46 .SH EXAMPLES
  47 .LP
  48 \fBExample 1 \fRExample of creating scratch directories.
  49 .sp
  50 .LP
  51 The following example creates scratch directories.
  52
  53 .sp
  54 .in +2
  55 .nf
  56 /* create scratch directories */
  57 if(mkdirp("/tmp/sub1/sub2/sub3", 0755) == \(mi1) {
  58         fprintf(stderr, "cannot create directory");
  59         exit(1);
  60 }
  61 chdir("/tmp/sub1/sub2/sub3");
  62 \&.
  63 \&.
  64 \&.
  65 /* cleanup */
  66 chdir("/tmp");
  67 rmdirp("sub1/sub2/sub3");
  68 .fi
  69 .in -2
  70
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for descriptions of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 MT-Level        MT-Safe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBchmod\fR(2), \fBmkdir\fR(2), \fBrmdir\fR(2), \fBmalloc\fR(3C),
  91 \fBattributes\fR(5)
  92 .SH NOTES
  93 .sp
  94 .LP
  95 The \fBmkdirp()\fR function uses \fBmalloc\fR(3C) to allocate temporary space
  96 for the string.