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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)truncate.2  8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd December 13, 2006
  32 .Dt TRUNCATE 2
  33 .Os
  34 .Sh NAME
  35 .Nm truncate ,
  36 .Nm ftruncate
  37 .Nd truncate or extend a file to a specified length
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In unistd.h
  42 .Ft int
  43 .Fn truncate "const char *path" "off_t length"
  44 .Ft int
  45 .Fn ftruncate "int fd" "off_t length"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn truncate
  49 system call
  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.
  57 If the file
  58 was larger than this size, the extra data
  59 is lost.
  60 If the file was smaller than this size,
  61 it will be extended as if by writing bytes
  62 with the value zero.
  63 With
  64 .Fn ftruncate ,
  65 the file must be open for writing.
  66 .Sh RETURN VALUES
  67 .Rv -std
  68 If the file to be modified is not a directory or
  69 a regular file, the
  70 .Fn truncate
  71 call has no effect and returns the value 0.
  72 .Sh ERRORS
  73 The
  74 .Fn truncate
  75 system call
  76 succeeds unless:
  77 .Bl -tag -width Er
  78 .It Bq Er ENOTDIR
  79 A component of the path prefix is not a directory.
  80 .It Bq Er ENAMETOOLONG
  81 A component of a pathname exceeded 255 characters,
  82 or an entire path name exceeded 1023 characters.
  83 .It Bq Er ENOENT
  84 The named file does not exist.
  85 .It Bq Er EACCES
  86 Search permission is denied for a component of the path prefix.
  87 .It Bq Er EACCES
  88 The named file is not writable by the user.
  89 .It Bq Er ELOOP
  90 Too many symbolic links were encountered in translating the pathname.
  91 .It Bq Er EPERM
  92 The named file has its immutable or append-only flag set, see the
  93 .Xr chflags 2
  94 manual page for more information.
  95 .It Bq Er EISDIR
  96 The named file is a directory.
  97 .It Bq Er EROFS
  98 The named file resides on a read-only file system.
  99 .It Bq Er ETXTBSY
 100 The file is a pure procedure (shared text) file that is being executed.
 101 .It Bq Er EFBIG
 102 The
 103 .Fa length
 104 argument was greater than the maximum file size.
 105 .It Bq Er EINVAL
 106 The
 107 .Fa length
 108 argument was less than 0.
 109 .It Bq Er EIO
 110 An I/O error occurred updating the inode.
 111 .It Bq Er EFAULT
 112 The
 113 .Fa path
 114 argument
 115 points outside the process's allocated address space.
 116 .El
 117 .Pp
 118 The
 119 .Fn ftruncate
 120 system call
 121 succeeds unless:
 122 .Bl -tag -width Er
 123 .It Bq Er EBADF
 124 The
 125 .Fa fd
 126 argument
 127 is not a valid descriptor.
 128 .It Bq Er EINVAL
 129 The
 130 .Fa fd
 131 argument
 132 references a socket, not a file.
 133 .It Bq Er EINVAL
 134 The
 135 .Fa fd
 136 descriptor
 137 is not open for writing.
 138 .El
 139 .Sh SEE ALSO
 140 .Xr chflags 2 ,
 141 .Xr open 2
 142 .Sh HISTORY
 143 The
 144 .Fn truncate
 145 system call appeared in
 146 .Bx 4.2 .
 147 .Sh BUGS
 148 These calls should be generalized to allow ranges
 149 of bytes in a file to be discarded.
 150 .Pp
 151 Use of
 152 .Fn truncate
 153 to extend a file is not portable.