/usr/share/doc/libbobcat4-dev/man/user.3.html is in libbobcat-dev 4.08.02-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | <!DOCTYPE html><html><head>
<meta charset="UTF-8">
<title>FBB::User(3bobcat)</title>
<style type="text/css">
figure {text-align: center;}
img {vertical-align: center;}
.XXfc {margin-left:auto;margin-right:auto;}
.XXtc {text-align: center;}
.XXtl {text-align: left;}
.XXtr {text-align: right;}
.XXvt {vertical-align: top;}
.XXvb {vertical-align: bottom;}
</style>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr/>
<h1 id="title">FBB::User(3bobcat)</h1>
<h2 id="author">/etc/passwd user info<br/>(libbobcat-dev_4.08.02-x.tar.gz)</h2>
<h2 id="date">2005-2017</h2>
<p>
<h2 >NAME</h2>FBB::User - Provides the <em >/etc/passwd</em> info of the current user
<p>
<h2 >SYNOPSIS</h2>
<strong >#include <bobcat/user></strong><br/>
Linking option: <em >-lbobcat</em>
<p>
<h2 >DESCRIPTION</h2>
This class retrieves the information of the current user from the
information in <em >/etc/passwd</em>. The class is a simple wrapper class around the
<strong >getpwent</strong>(3) function.
<p>
<h2 >NAMESPACE</h2>
<strong >FBB</strong><br/>
All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace <strong >FBB</strong>.
<p>
<h2 >INHERITS FROM</h2>
-
<p>
<h2 >CONSTRUCTORS</h2>
<ul>
<li> <strong >User()</strong>:<br/>
The default constructor determines the current user's data.
This constructor throws an <em >Exception</em> exception if it did not properly
complete because the current user name could not be found in <em >/etc/passwd</em>.
</ul>
The copy and move constructors are available.
<p>
<h2 >OVERLOADED OPERATORS</h2>
<p>
The copy and move assignment operators are available.
<p>
<h2 >MEMBER FUNCTIONS</h2>
<ul>
<li> <strong >size_t eGroupid() const</strong>:<br/>
Returns the user's <em >effective</em> group-id.
<li> <strong >size_t eUserid() const</strong>:<br/>
Returns the user's <em >effective</em> user-id.
<li> <strong >size_t groupid() const</strong>:<br/>
Returns the user's group-id.
<li> <strong >std::string homedir() const</strong>:<br/>
Returns the user's home directory (including a trailing <em >/</em>).
<li> <strong >bool inGroup(size_t gid, bool useEffective = true) const</strong>:<br/>
Returns <em >true</em> if the current user is a member of group <em >gid</em>,
otherwise <em >false</em> is returned. The user's effective group id is also
checked if <em >useEffective</em> is specified as <em >true</em> (which is
provided as default function argument).
<li> <strong >std::string name() const</strong>:<br/>
Returns the user's user-name.
<li> <strong >std::string password() const</strong>:<br/>
Returns the user's encrypted password. But see also the <strong >BUGS</strong> section.
<li> <strong >std::string realname() const</strong>:<br/>
Returns the user's real name, as listed in the <em >/etc/passwd</em>'s <em >gecos</em> field.
<li> <strong >std::string shell() const</strong>:<br/>
Returns the user's shell.
<li> <strong >size_t userid() const</strong>:<br/>
Returns the user's user-id.
</ul>
<p>
<h2 >EXAMPLE</h2>
<pre >
#include <bobcat/user>
#include <iostream>
using namespace std;
using namespace FBB;
int main()
{
User user;
cout << "\n"
"name : " << user.name() << "\n" <<
"password : " << user.password() << "\n" <<
"user id : " << user.userid() << "\n" <<
"group id : " << user.groupid() << "\n" <<
"real name : " << user.realname() << "\n" <<
"home dir : " << user.homedir() << "\n" <<
"shell : " << user.shell() << "\n" << endl;
}
</pre>
<p>
<h2 >FILES</h2>
<em >bobcat/user</em> - defines the class interface
<p>
<h2 >SEE ALSO</h2>
<strong >bobcat</strong>(7), <strong >getpwent</strong>(3)
<p>
<h2 >BUGS</h2>
If the user is a member of multiple groups, only the group id listed in
<em >/etc/passwd</em> is returned by <strong >groupid()</strong>.
<p>
If shadow passwording is used, the string returned by <strong >password()</strong> will
probably not contain the encrypted password.
<p>
<h2 >DISTRIBUTION FILES</h2>
<ul>
<li> <em >bobcat_4.08.02-x.dsc</em>: detached signature;
<li> <em >bobcat_4.08.02-x.tar.gz</em>: source archive;
<li> <em >bobcat_4.08.02-x_i386.changes</em>: change log;
<li> <em >libbobcat1_4.08.02-x_*.deb</em>: debian package holding the
libraries;
<li> <em >libbobcat1-dev_4.08.02-x_*.deb</em>: debian package holding the
libraries, headers and manual pages;
<li> <em >http://sourceforge.net/projects/bobcat</em>: public archive location;
</ul>
<p>
<h2 >BOBCAT</h2>
Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.
<p>
<h2 >COPYRIGHT</h2>
This is free software, distributed under the terms of the
GNU General Public License (GPL).
<p>
<h2 >AUTHOR</h2>
Frank B. Brokken (<strong >f.b.brokken@rug.nl</strong>).
<p>
</body>
</html>
|