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