Initial commit for Tizen
[profile/extras/shadow-utils.git] / man / porttime.5.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3    Copyright (c) 1989 - 1990, Julianne Frances Haugh
4    Copyright (c) 2007 - 2008, Nicolas François
5    All rights reserved.
6   
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    1. Redistributions of source code must retain the above copyright
11       notice, this list of conditions and the following disclaimer.
12    2. Redistributions in binary form must reproduce the above copyright
13       notice, this list of conditions and the following disclaimer in the
14       documentation and/or other materials provided with the distribution.
15    3. The name of the copyright holders or contributors may not be used to
16       endorse or promote products derived from this software without
17       specific prior written permission.
18   
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
23    HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 -->
31 <refentry id='porttime.5'>
32   <!--  $Id: porttime.5.xml 2435 2008-10-11 11:44:43Z nekral-guest $ -->
33   <refmeta>
34     <refentrytitle>porttime</refentrytitle>
35     <manvolnum>5</manvolnum>
36     <refmiscinfo class="sectdesc">File Formats and Conversions</refmiscinfo>
37   </refmeta>
38   <refnamediv id='name'>
39     <refname>porttime</refname>
40     <refpurpose>port access time file</refpurpose>
41   </refnamediv>
42
43   <refsect1 id='description'>
44     <title>DESCRIPTION</title>
45     <para>
46       <emphasis remap='I'>porttime</emphasis> contains a list of tty
47       devices, user names, and permitted login times.
48     </para>
49
50     <para>
51       Each entry consists of three colon separated fields. The first field
52       is a comma separated list of tty devices, or an asterisk to indicate
53       that all tty devices are matched by this entry. The second field is a
54       comma separated list of user names, or an asterisk to indicated that
55       all user names are matched by this entry. The third field is a comma
56       separated list of permitted access times.
57     </para>
58
59     <para>
60       Each access time entry consists of zero or more days of the week,
61       abbreviated <emphasis>Su</emphasis>, <emphasis>Mo</emphasis>,
62       <emphasis>Tu</emphasis>, <emphasis>We</emphasis>,
63       <emphasis>Th</emphasis>, <emphasis>Fr</emphasis>, and
64       <emphasis>Sa</emphasis>, followed by a pair of times separated by a
65       hyphen. The abbreviation <emphasis>Wk</emphasis> may be used to
66       represent Monday thru Friday, and <emphasis>Al</emphasis> may be used
67       to indicate every day. If no days are given, <emphasis>Al</emphasis>
68       is assumed.
69     </para>
70   </refsect1>
71
72   <refsect1 id='examples'>
73     <title>EXAMPLES</title>
74     <para>
75       The following entry allows access to user <emphasis
76       remap='B'>jfh</emphasis> on every port during weekdays from 9am to
77       5pm.
78     </para>
79
80     <para>      *:jfh:Wk0900-1700</para>
81
82     <para>
83       The following entries allow access only to the users
84       <emphasis>root</emphasis> and <emphasis>oper</emphasis> on
85       <filename>/dev/console</filename> at any time. This illustrates how
86       the <filename>/etc/porttime</filename> file is an ordered list of
87       access times. Any other user would match the second entry which does
88       not permit access at any time.
89     </para>
90
91     <programlisting>
92       console:root,oper:Al0000-2400
93       console:*:
94     </programlisting>
95
96     <para>
97       The following entry allows access for the user
98       <emphasis>games</emphasis> on any port during non-working hours. 
99     </para>
100
101     <para>      *:games:Wk1700-0900,SaSu0000-2400</para>
102   </refsect1>
103
104   <refsect1 id='files'>
105     <title>FILES</title>
106     <variablelist>
107       <varlistentry>
108         <term><filename>/etc/porttime</filename></term>
109         <listitem>
110           <para>File containing port access.</para>
111         </listitem>
112       </varlistentry>
113     </variablelist>
114   </refsect1>
115
116   <refsect1 id='see_also'>
117     <title>SEE ALSO</title>
118     <para>
119       <citerefentry>
120         <refentrytitle>login</refentrytitle><manvolnum>1</manvolnum>
121       </citerefentry>.
122     </para>
123   </refsect1>
124 </refentry>