xref: /original-bsd/lib/libc/sys/truncate.2 (revision cd32dc80)
Copyright (c) 1983 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)truncate.2 6.7 (Berkeley) 05/18/89

TRUNCATE 2 ""
C 5
NAME
truncate - truncate a file to a specified length
SYNOPSIS
truncate(path, length)
char *path;
off_t length;

ftruncate(fd, length) int fd; off_t length;

DESCRIPTION
Truncate causes the file named by path or referenced by fd to be truncated to at most length bytes in size. If the file previously was larger than this size, the extra data is lost. With ftruncate , the file must be open for writing.
"RETURN VALUES
A value of 0 is returned if the call succeeds. If the call fails a -1 is returned, and the global variable errno specifies the error.
"ERRORS
Truncate succeeds unless:

15 [ENOTDIR] A component of the path prefix is not a directory.

15 [EINVAL] The pathname contains a character with the high-order bit set.

15 [ENAMETOOLONG] A component of a pathname exceeded 255 characters, or an entire path name exceeded 1023 characters.

15 [ENOENT] The named file does not exist.

15 [EACCES] Search permission is denied for a component of the path prefix.

15 [EACCES] The named file is not writable by the user.

15 [ELOOP] Too many symbolic links were encountered in translating the pathname.

15 [EISDIR] The named file is a directory.

15 [EROFS] The named file resides on a read-only file system.

15 [ETXTBSY] The file is a pure procedure (shared text) file that is being executed.

15 [EIO] An I/O error occurred updating the inode.

15 [EFAULT] Path points outside the process's allocated address space.

Ftruncate succeeds unless:

15 [EBADF] The fd is not a valid descriptor.

15 [EINVAL] The fd references a socket, not a file.

15 [EINVAL] The fd is not open for writing.

"SEE ALSO"
open(2)
BUGS
These calls should be generalized to allow ranges of bytes in a file to be discarded.