← Back to branch summary

~ubuntu-branches/ubuntu/vivid/munge/vivid

« back to all changes in this revision

Viewing changes to src/libmunge/munge_enum.3.in

  • Committer: Bazaar Package Importer
  • Author(s): Gennaro Oliva
  • Date: 2011-02-28 20:41:12 UTC
  • mfrom: (6.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20110228204112-2lc8ss9geeusv5uo
Tags: 0.5.10-1
* New upstream release 
* Updated copyright, homepage, watch thanks to Chris Dunlap
* Standards version upgraded to 3.9.1.0 (no changes) 
* Switch to dpkg-source 3.0 (quilt) format
* Added explicit dependency by the same version of libmunge for munge

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/libmunge/munge_enum.3.in
1
1
.\"****************************************************************************
2
 
.\" $Id: munge_enum.3.in 771 2010-03-02 23:14:07Z dun $
 
2
.\" $Id: munge_enum.3.in 890 2011-01-20 01:54:21Z chris.m.dunlap $
3
3
.\"****************************************************************************
4
4
.\" Written by Chris Dunlap <cdunlap@llnl.gov>.
5
 
.\" Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
 
5
.\" Copyright (C) 2007-2011 Lawrence Livermore National Security, LLC.
6
6
.\" Copyright (C) 2002-2007 The Regents of the University of California.
7
7
.\" UCRL-CODE-155910.
8
8
.\"
9
9
.\" This file is part of the MUNGE Uid 'N' Gid Emporium (MUNGE).
10
 
.\" For details, see <http://home.gna.org/munge/>.
 
10
.\" For details, see <http://munge.googlecode.com/>.
11
11
.\"
12
12
.\" MUNGE is free software: you can redistribute it and/or modify it under
13
13
.\" the terms of the GNU General Public License as published by the Free
46
46
.fi
47
47
 
48
48
.SH DESCRIPTION
49
 
The \fBmunge_enum_is_valid\fR() function checks if the given value \fIval\fR
50
 
is a valid MUNGE enumeration of the specified type \fItype\fR in the software
51
 
configuration as currently compiled.  Some enumerations correspond to options
52
 
that can only be enabled at compile-time.
 
49
The \fBmunge_enum_is_valid\fR() function checks if the given value
 
50
\fIval\fR is a valid MUNGE enumeration of the specified type \fItype\fR
 
51
in the software configuration as currently compiled.  Some enumerations
 
52
correspond to options that can only be enabled at compile-time.
53
53
.PP
54
54
The \fBmunge_enum_int_to_str\fR() function converts the MUNGE enumeration
55
55
\fIval\fR of the specified type \fItype\fR into a text string.
59
59
of the specified type \fItype\fR.
60
60
 
61
61
.SH RETURN VALUE
62
 
The \fBmunge_enum_is_valid\fR() function returns non-zero if the given value
63
 
\fIval\fR is a valid enumeration.
 
62
The \fBmunge_enum_is_valid\fR() function returns non-zero if the given
 
63
value \fIval\fR is a valid enumeration.
64
64
.PP
65
65
The \fBmunge_enum_int_to_str\fR() function returns a NUL-terminated constant
66
 
text string, or NULL on error; this string should not be freed or modified by
67
 
the caller.
 
66
text string, or NULL on error; this string should not be freed or modified
 
67
by the caller.
68
68
.PP
69
69
The \fBmunge_enum_str_to_int\fR() function returns a MUNGE enumeration on
70
70
success (i.e., >= 0), or \-1 on error.
113
113
@META_AUTHOR@
114
114
 
115
115
.SH COPYRIGHT
116
 
Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
 
116
Copyright (C) 2007-2011 Lawrence Livermore National Security, LLC.
117
117
.br
118
118
Copyright (C) 2002-2007 The Regents of the University of California.
119
 
 
120
 
MUNGE is free software: you can redistribute it and/or modify it under
121
 
the terms of the GNU General Public License as published by the Free
122
 
Software Foundation, either version 3 of the License, or (at your option)
123
 
any later version.  Additionally for the MUNGE library (libmunge), you
124
 
can redistribute it and/or modify it under the terms of the GNU Lesser
125
 
General Public License as published by the Free Software Foundation,
126
 
either version 3 of the License, or (at your option) any later version.
 
119
.PP
 
120
MUNGE is free software: you can redistribute it and/or modify it under the
 
121
terms of the GNU General Public License as published by the Free Software
 
122
Foundation, either version 3 of the License, or (at your option) any later
 
123
version.
 
124
.PP
 
125
Additionally for the MUNGE library (libmunge), you can redistribute it
 
126
and/or modify it under the terms of the GNU Lesser General Public License as
 
127
published by the Free Software Foundation, either version 3 of the License,
 
128
or (at your option) any later version.
127
129
 
128
130
.SH "SEE ALSO"
129
131
.BR munge (1),
134
136
.BR munge (7),
135
137
.BR munged (8).
136
138
.PP
137
 
\fBhttp://home.gna.org/munge/\fR
 
139
\fBhttp://munge.googlecode.com/\fR