login_times.3 (112541) | login_times.3 (131504) |
---|---|
1.\" Copyright (c) 1995 David Nugent <davidn@blaze.net.au> 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, is permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice immediately at the beginning of the file, without modification, 9.\" this list of conditions, and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. This work was done expressly for inclusion into FreeBSD. Other use 14.\" is permitted provided this notation is included. 15.\" 4. Absolutely no warranty of function or purpose is made by the author 16.\" David Nugent. 17.\" 5. Modifications may be freely made to this file providing the above 18.\" conditions are met. 19.\" | 1.\" Copyright (c) 1995 David Nugent <davidn@blaze.net.au> 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, is permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice immediately at the beginning of the file, without modification, 9.\" this list of conditions, and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. This work was done expressly for inclusion into FreeBSD. Other use 14.\" is permitted provided this notation is included. 15.\" 4. Absolutely no warranty of function or purpose is made by the author 16.\" David Nugent. 17.\" 5. Modifications may be freely made to this file providing the above 18.\" conditions are met. 19.\" |
20.\" $FreeBSD: head/lib/libutil/login_times.3 112541 2003-03-24 16:02:05Z charnier $ | 20.\" $FreeBSD: head/lib/libutil/login_times.3 131504 2004-07-02 23:52:20Z ru $ |
21.\" 22.Dd January 2, 1997 23.Os 24.Dt LOGIN_TIMES 3 25.Sh NAME 26.Nm parse_lt , 27.Nm in_ltm , 28.Nm in_ltms --- 62 unchanged lines hidden (view full) --- 91described period begins and ends. 92The 93.Ar lt_dow 94field is a bit field, containing one bit for each day of the week 95and one bit unused. 96A series 97.Em LTM_* 98macros may be used for testing bits individually and in combination. | 21.\" 22.Dd January 2, 1997 23.Os 24.Dt LOGIN_TIMES 3 25.Sh NAME 26.Nm parse_lt , 27.Nm in_ltm , 28.Nm in_ltms --- 62 unchanged lines hidden (view full) --- 91described period begins and ends. 92The 93.Ar lt_dow 94field is a bit field, containing one bit for each day of the week 95and one bit unused. 96A series 97.Em LTM_* 98macros may be used for testing bits individually and in combination. |
99If no bits are set in this field - ie. it contains the value | 99If no bits are set in this field - i.e., it contains the value |
100.Em LTM_NONE 101- then the entire period is assumed invalid. 102This is used as a convention to mark the termination of an array 103of login_time_t values. 104If 105.Fn parse_lt 106returns a 107.Ar login_time_t --- 29 unchanged lines hidden (view full) --- 137.Em LTM_NONE . 138.Sh RETURN VALUES 139The 140.Fn parse_lt 141function returns a filled in structure of type login_time_t containing the 142parsed time period. 143If a parsing error occurs, the lt_dow field is set to 144.Em LTM_NONE | 100.Em LTM_NONE 101- then the entire period is assumed invalid. 102This is used as a convention to mark the termination of an array 103of login_time_t values. 104If 105.Fn parse_lt 106returns a 107.Ar login_time_t --- 29 unchanged lines hidden (view full) --- 137.Em LTM_NONE . 138.Sh RETURN VALUES 139The 140.Fn parse_lt 141function returns a filled in structure of type login_time_t containing the 142parsed time period. 143If a parsing error occurs, the lt_dow field is set to 144.Em LTM_NONE |
145(i.e. 0). | 145(i.e., 0). |
146.Pp 147The 148.Fn in_ltm 149function returns non-zero if the given time falls within the period described 150by the login_time_t passed as the first parameter. 151.Pp 152The 153.Fn in_ltms 154function returns the index of the first time period found in which the given 155time falls, or -1 if none of them apply. 156.Sh SEE ALSO 157.Xr getcap 3 , 158.Xr login_cap 3 , 159.Xr login_class 3 , 160.Xr login.conf 5 , 161.Xr termcap 5 | 146.Pp 147The 148.Fn in_ltm 149function returns non-zero if the given time falls within the period described 150by the login_time_t passed as the first parameter. 151.Pp 152The 153.Fn in_ltms 154function returns the index of the first time period found in which the given 155time falls, or -1 if none of them apply. 156.Sh SEE ALSO 157.Xr getcap 3 , 158.Xr login_cap 3 , 159.Xr login_class 3 , 160.Xr login.conf 5 , 161.Xr termcap 5 |