lib/libc/sys/truncate.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)truncate.2  8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt TRUNCATE 2
  37 .Os BSD 4.2
  38 .Sh NAME
  39 .Nm truncate ,
  40 .Nm ftruncate
  41 .Nd truncate or extend a file to a specified length
  42 .Sh SYNOPSIS
  43 .Fd #include <unistd.h>
  44 .Ft int
  45 .Fn truncate "const char *path" "off_t length"
  46 .Ft int
  47 .Fn ftruncate "int fd" "off_t length"
  48 .Sh DESCRIPTION
  49 .Fn Truncate
  50 causes the file named by
  51 .Fa path
  52 or referenced by
  53 .Fa fd
  54 to be truncated or extended to
  55 .Fa length
  56 bytes in size.  If the file
  57 was larger than this size, the extra data
  58 is lost.
  59 If the file was smaller than this size,
  60 it will be extended as if by writing bytes
  61 with the value zero.
  62 With
  63 .Fn ftruncate ,
  64 the file must be open for writing.
  65 .Sh RETURN VALUES
  66 A value of 0 is returned if the call succeeds.  If the call
  67 fails a -1 is returned, and the global variable
  68 .Va errno
  69 specifies the error.
  70 .Sh ERRORS
  71 .Fn Truncate
  72 succeeds unless:
  73 .Bl -tag -width [ENOTDIR]
  74 .It Bq Er ENOTDIR
  75 A component of the path prefix is not a directory.
  76 .It Bq Er ENAMETOOLONG
  77 A component of a pathname exceeded 255 characters,
  78 or an entire path name exceeded 1023 characters.
  79 .It Bq Er ENOENT
  80 The named file does not exist.
  81 .It Bq Er EACCES
  82 Search permission is denied for a component of the path prefix.
  83 .It Bq Er EACCES
  84 The named file is not writable by the user.
  85 .It Bq Er ELOOP
  86 Too many symbolic links were encountered in translating the pathname.
  87 .It Bq Er EISDIR
  88 The named file is a directory.
  89 .It Bq Er EROFS
  90 The named file resides on a read-only file system.
  91 .It Bq Er ETXTBSY
  92 The file is a pure procedure (shared text) file that is being executed.
  93 .It Bq Er EIO
  94 An I/O error occurred updating the inode.
  95 .It Bq Er EFAULT
  96 .Fa Path
  97 points outside the process's allocated address space.
  98 .El
  99 .Pp
 100 .Fn Ftruncate
 101 succeeds unless:
 102 .Bl -tag -width [ENOTDIR]
 103 .It Bq Er EBADF
 104 The
 105 .Fa fd
 106 is not a valid descriptor.
 107 .It Bq Er EINVAL
 108 The
 109 .Fa fd
 110 references a socket, not a file.
 111 .It Bq Er EINVAL
 112 The
 113 .Fa fd
 114 is not open for writing.
 115 .El
 116 .Sh SEE ALSO
 117 .Xr open 2
 118 .Sh BUGS
 119 These calls should be generalized to allow ranges
 120 of bytes in a file to be discarded.
 121 .Pp
 122 Use of
 123 .Fn truncate
 124 to extend a file is not portable.
 125 .Sh HISTORY
 126 The
 127 .Fn truncate
 128 function call appeared in
 129 .Bx 4.2 .