Changeset 288 in openpam for trunk


Ignore:
Timestamp:
Jan 28, 2005, 2:08:44 PM (14 years ago)
Author:
Dag-Erling Smørgrav
Message:

Hard sentence breaks in inline documentation.

Location:
trunk/lib
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • trunk/lib/openpam_borrow_cred.c

    r284 r288  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/openpam_borrow_cred.c#12 $
     34 * $P4: //depot/projects/openpam/lib/openpam_borrow_cred.c#13 $
    3535 */
    3636
     
    110110/**
    111111 * The =openpam_borrow_cred function saves the current credentials and
    112  * switches to those of the user specified by its =pwd argument.  The
    113  * affected credentials are the effective UID, the effective GID, and the
    114  * group access list.  The original credentials can be restored using
    115  * =openpam_restore_cred.
     112 * switches to those of the user specified by its =pwd argument.
     113 * The affected credentials are the effective UID, the effective GID, and
     114 * the group access list.
     115 * The original credentials can be restored using =openpam_restore_cred.
    116116 *
    117117 * >setegid 2
  • trunk/lib/openpam_free_data.c

    r245 r288  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/openpam_free_data.c#5 $
     34 * $P4: //depot/projects/openpam/lib/openpam_free_data.c#6 $
    3535 */
    3636
     
    6565/**
    6666 * The =openpam_free_data is a cleanup function suitable for passing to
    67  * =pam_set_data.  It simply releases the data by passing its =data
    68  * argument to =free.
     67 * =pam_set_data.
     68 * It simply releases the data by passing its =data argument to =free.
    6969 */
  • trunk/lib/openpam_log.c

    r245 r288  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/openpam_log.c#23 $
     34 * $P4: //depot/projects/openpam/lib/openpam_log.c#24 $
    3535 */
    3636
     
    123123
    124124/**
    125  * The =openpam_log function logs messages using =syslog.  It is primarily
    126  * intended for internal use by the library and modules.
     125 * The =openpam_log function logs messages using =syslog.
     126 * It is primarily intended for internal use by the library and modules.
    127127 *
    128  * The =level argument indicates the importance of the message.  The
    129  * following levels are defined:
     128 * The =level argument indicates the importance of the message.
     129 * The following levels are defined:
    130130 *
    131131 *      =PAM_LOG_DEBUG:
    132  *              Debugging messages.  These messages are normally not
    133  *              logged unless the global integer variable :_openpam_debug
    134  *              is set to a non-zero value, in which case they are logged
    135  *              with a =syslog priority of =LOG_DEBUG.
     132 *              Debugging messages.
     133 *              These messages are normally not logged unless the global
     134 *              integer variable :_openpam_debug is set to a non-zero
     135 *              value, in which case they are logged with a =syslog
     136 *              priority of =LOG_DEBUG.
    136137 *      =PAM_LOG_VERBOSE:
    137138 *              Information about the progress of the authentication
    138  *              process, or other non-essential messages.  These messages
    139  *              are logged with a =syslog priority of =LOG_INFO.
     139 *              process, or other non-essential messages.
     140 *              These messages are logged with a =syslog priority of
     141 *              =LOG_INFO.
    140142 *      =PAM_LOG_NOTICE:
    141  *              Messages relating to non-fatal errors.  These messages are
    142  *              logged with a =syslog priority of =LOG_NOTICE.
     143 *              Messages relating to non-fatal errors.
     144 *              These messages are logged with a =syslog priority of
     145 *              =LOG_NOTICE.
    143146 *      =PAM_LOG_ERROR:
    144  *              Messages relating to serious errors.  These messages are
    145  *              logged with a =syslog priority of =LOG_ERR.
     147 *              Messages relating to serious errors.
     148 *              These messages are logged with a =syslog priority of
     149 *              =LOG_ERR.
    146150 *
    147151 * The remaining arguments are a =printf format string and the
  • trunk/lib/openpam_nullconv.c

    r245 r288  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/openpam_nullconv.c#6 $
     34 * $P4: //depot/projects/openpam/lib/openpam_nullconv.c#7 $
    3535 */
    3636
     
    7171 * The =openpam_nullconv function is a null conversation function suitable
    7272 * for applications that want to use PAM but don't support interactive
    73  * dialog with the user.  Such applications should set =PAM_AUTHTOK to
    74  * whatever authentication token they've obtained on their own before
    75  * calling =pam_authenticate and / or =pam_chauthtok, and their PAM
    76  * configuration should specify the ;use_first_pass option for all modules
    77  * that require access to the authentication token, to make sure they use
    78  * =PAM_AUTHTOK rather than try to query the user.
     73 * dialog with the user.
     74 * Such applications should set =PAM_AUTHTOK to whatever authentication
     75 * token they've obtained on their own before calling =pam_authenticate
     76 * and / or =pam_chauthtok, and their PAM configuration should specify the
     77 * ;use_first_pass option for all modules that require access to the
     78 * authentication token, to make sure they use =PAM_AUTHTOK rather than
     79 * try to query the user.
    7980 *
    8081 * >openpam_ttyconv
  • trunk/lib/openpam_ttyconv.c

    r275 r288  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/openpam_ttyconv.c#24 $
     34 * $P4: //depot/projects/openpam/lib/openpam_ttyconv.c#25 $
    3535 */
    3636
     
    231231/**
    232232 * The =openpam_ttyconv function is a standard conversation function
    233  * suitable for use on TTY devices.  It should be adequate for the needs
    234  * of most text-based interactive programs.
     233 * suitable for use on TTY devices.
     234 * It should be adequate for the needs of most text-based interactive
     235 * programs.
    235236 *
    236237 * The =openpam_ttyconv function allows the application to specify a
  • trunk/lib/pam_get_authtok.c

    r277 r288  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/pam_get_authtok.c#27 $
     34 * $P4: //depot/projects/openpam/lib/pam_get_authtok.c#28 $
    3535 */
    3636
     
    143143/**
    144144 * The =pam_get_authtok function returns the cached authentication token,
    145  * or prompts the user if no token is currently cached.  Either way, a
    146  * pointer to the authentication token is stored in the location pointed
    147  * to by the =authtok argument.
     145 * or prompts the user if no token is currently cached.
     146 * Either way, a pointer to the authentication token is stored in the
     147 * location pointed to by the =authtok argument.
    148148 *
    149149 * The =item argument must have one of the following values:
     
    158158 * The =prompt argument specifies a prompt to use if no token is cached.
    159159 * If it is =NULL, the =PAM_AUTHTOK_PROMPT or =PAM_OLDAUTHTOK_PROMPT item,
    160  * as appropriate, will be used.  If that item is also =NULL, a hardcoded
    161  * default prompt will be used.
     160 * as appropriate, will be used.
     161 * If that item is also =NULL, a hardcoded default prompt will be used.
    162162 *
    163163 * If =item is set to =PAM_AUTHTOK and there is a non-null =PAM_OLDAUTHTOK
    164164 * item, =pam_get_authtok will ask the user to confirm the new token by
    165  * retyping it.  If there is a mismatch, =pam_get_authtok will return
    166  * =PAM_TRY_AGAIN.
     165 * retyping it.
     166 * If there is a mismatch, =pam_get_authtok will return =PAM_TRY_AGAIN.
    167167 *
    168168 * >pam_get_item
  • trunk/lib/pam_get_user.c

    r277 r288  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/pam_get_user.c#19 $
     34 * $P4: //depot/projects/openpam/lib/pam_get_user.c#20 $
    3535 */
    3636
     
    9797/**
    9898 * The =pam_get_user function returns the name of the target user, as
    99  * specified to =pam_start.  If no user was specified, nor set using
    100  * =pam_set_item, =pam_get_user will prompt for a user name.  Either way,
    101  * a pointer to the user name is stored in the location pointed to by the
    102  * =user argument.
    103 
     99 * specified to =pam_start.
     100 * If no user was specified, nor set using =pam_set_item, =pam_get_user
     101 * will prompt for a user name.
     102 * Either way, a pointer to the user name is stored in the location
     103 * pointed to by the =user argument.
     104 *
    104105 * The =prompt argument specifies a prompt to use if no user name is
    105  * cached.  If it is =NULL, the =PAM_USER_PROMPT will be used.  If that
    106  * item is also =NULL, a hardcoded default prompt will be used.
     106 * cached.
     107 * If it is =NULL, the =PAM_USER_PROMPT will be used.
     108 * If that item is also =NULL, a hardcoded default prompt will be used.
    107109 *
    108110 * >pam_get_item
  • trunk/lib/pam_open_session.c

    r245 r288  
    3232 * SUCH DAMAGE.
    3333 *
    34  * $P4: //depot/projects/openpam/lib/pam_open_session.c#13 $
     34 * $P4: //depot/projects/openpam/lib/pam_open_session.c#14 $
    3535 */
    3636
     
    7272/**
    7373 * The =pam_open_session sets up a user session for a previously
    74  * authenticated user.  The session should later be torn down by a call to
    75  * =pam_close_session.
     74 * authenticated user.
     75 * The session should later be torn down by a call to =pam_close_session.
    7676 *
    7777 * The =flags argument is the binary or of zero or more of the following
Note: See TracChangeset for help on using the changeset viewer.