Mercurial > repos > rliterman > csp2
comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man3/keyctl_clear.3 @ 68:5028fdace37b
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
| author | jpayne |
|---|---|
| date | Tue, 18 Mar 2025 16:23:26 -0400 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 67:0e9998148a16 | 68:5028fdace37b |
|---|---|
| 1 .\" | |
| 2 .\" Copyright (C) 2006 Red Hat, Inc. All Rights Reserved. | |
| 3 .\" Written by David Howells (dhowells@redhat.com) | |
| 4 .\" | |
| 5 .\" This program is free software; you can redistribute it and/or | |
| 6 .\" modify it under the terms of the GNU General Public License | |
| 7 .\" as published by the Free Software Foundation; either version | |
| 8 .\" 2 of the License, or (at your option) any later version. | |
| 9 .\" | |
| 10 .TH KEYCTL_CLEAR 3 "4 May 2006" Linux "Linux Key Management Calls" | |
| 11 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | |
| 12 .SH NAME | |
| 13 keyctl_clear \- clear a keyring | |
| 14 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | |
| 15 .SH SYNOPSIS | |
| 16 .nf | |
| 17 .B #include <keyutils.h> | |
| 18 .sp | |
| 19 .BI "long keyctl_clear(key_serial_t " keyring ");" | |
| 20 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | |
| 21 .SH DESCRIPTION | |
| 22 .BR keyctl_clear () | |
| 23 clears the contents of a | |
| 24 .IR keyring . | |
| 25 .P | |
| 26 The caller must have | |
| 27 .B write | |
| 28 permission on a keyring to be able clear it. | |
| 29 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | |
| 30 .SH RETURN VALUE | |
| 31 On success | |
| 32 .BR keyctl_clear () | |
| 33 returns | |
| 34 .BR 0 . | |
| 35 On error, the value | |
| 36 .B -1 | |
| 37 will be returned and | |
| 38 .I errno | |
| 39 will have been set to an appropriate error. | |
| 40 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | |
| 41 .SH ERRORS | |
| 42 .TP | |
| 43 .B ENOKEY | |
| 44 The keyring specified is invalid. | |
| 45 .TP | |
| 46 .B EKEYEXPIRED | |
| 47 The keyring specified has expired. | |
| 48 .TP | |
| 49 .B EKEYREVOKED | |
| 50 The keyring specified had been revoked. | |
| 51 .TP | |
| 52 .B EACCES | |
| 53 The keyring exists, but is not | |
| 54 .B writable | |
| 55 by the calling process. | |
| 56 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | |
| 57 .SH LINKING | |
| 58 This is a library function that can be found in | |
| 59 .IR libkeyutils . | |
| 60 When linking, | |
| 61 .B \-lkeyutils | |
| 62 should be specified to the linker. | |
| 63 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | |
| 64 .SH SEE ALSO | |
| 65 .ad l | |
| 66 .nh | |
| 67 .BR keyctl (1), | |
| 68 .BR add_key (2), | |
| 69 .BR keyctl (2), | |
| 70 .BR request_key (2), | |
| 71 .BR keyctl (3), | |
| 72 .BR keyrings (7), | |
| 73 .BR keyutils (7) | |
| 74 |