xref: /original-bsd/lib/libc/sys/truncate.2 (revision 8b257aca)
Copyright (c) 1983 Regents of the University of California.
All rights reserved. The Berkeley software License Agreement
specifies the terms and conditions for redistribution.

@(#)truncate.2 6.3 (Berkeley) 06/30/85

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

ftruncate(fd, length) int fd, 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 [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] Name 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.

"SEE ALSO"
open(2)
BUGS
Partial blocks discarded as the result of truncation are not zero filled; this can result in holes in files that do not read as zero.

These calls should be generalized to allow ranges of bytes in a file to be discarded.