debian man page for user

FBB::User(3bobcat)					       /etc/passwd user info						FBB::User(3bobcat)

NAME
       FBB::User - Provides the /etc/passwd info of the current user

SYNOPSIS
       #include <bobcat/user>
       Linking option: -lbobcat

DESCRIPTION
       This  class  retrieves  the information of the current user from the information in /etc/passwd. The class is a simple wrapper class around
       the getpwent(3) function.

NAMESPACE
       FBB
       All constructors, members, operators and manipulators, mentioned in this man-page, are defined in the namespace FBB.

INHERITS FROM
       -

CONSTRUCTORS
       o      User():
	      The default constructor determines the current user's data.  This constructor throws an Errno exception if it did not properly  com-
	      plete because the current user name could not be found in /etc/passwd.  The copy and move constructors are available.

OVERLOADED OPERATORS
       The copy and move assignment operators are available.

MEMBER FUNCTIONS
       o      size_t groupid() const:
	      Returns the user's group-id.

       o      std::string homedir() const:
	      Returns the user's home directory (including a trailing /).

       o      std::string name() const:
	      Returns the user's user-name.

       o      std::string password() const:
	      Returns the user's encrypted password. But see also the BUGS section.

       o      std::string realname() const:
	      Returns the user's real name, as listed in the /etc/passwd's gecos field.

       o      std::string shell() const:
	      Returns the user's shell.

       o      size_t userid() const:
	      Returns the user's user-id.

       o      void verify() const:
	      Obsoleted, will be removed in a future Bobcat release.

EXAMPLE
       #include <bobcat/user>
       #include <iostream>

       using namespace std;
       using namespace FBB;

       int main()
       {
	   User  user;
	   user.verify();

	   cout << "
"
	       "name	   : " << user.name()	   << "
" <<
	       "password   : " << user.password()  << "
" <<
	       "user id    : " << user.userid()    << "
" <<
	       "group id   : " << user.groupid()   << "
" <<
	       "real name  : " << user.realname()  << "
" <<
	       "home dir   : " << user.homedir()   << "
" <<
	       "shell	   : " << user.shell()	   << "
" << endl;

	   return 0;
       }

FILES
       bobcat/user - defines the class interface

SEE ALSO
       bobcat(7), getpwent(3)

BUGS
       If the user is a member of multiple groups, only the group id listed in /etc/passwd is returned by groupid().

       If shadow passwording is used, the string returned by password() will probably not contain the encrypted password.

DISTRIBUTION FILES
       o      bobcat_3.01.00-x.dsc: detached signature;

       o      bobcat_3.01.00-x.tar.gz: source archive;

       o      bobcat_3.01.00-x_i386.changes: change log;

       o      libbobcat1_3.01.00-x_*.deb: debian package holding the libraries;

       o      libbobcat1-dev_3.01.00-x_*.deb: debian package holding the libraries, headers and manual pages;

       o      http://sourceforge.net/projects/bobcat: public archive location;

BOBCAT
       Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.

COPYRIGHT
       This is free software, distributed under the terms of the GNU General Public License (GPL).

AUTHOR
       Frank B. Brokken (f.b.brokken@rug.nl).

libbobcat1-dev_3.01.00-x.tar.gz 				     2005-2012							FBB::User(3bobcat)