added profiles documentation

This commit is contained in:
Roland Gruber 2004-10-09 11:05:52 +00:00
parent 6761f601c6
commit 0a1c37fc86
3 changed files with 63 additions and 2 deletions

View File

@ -47,7 +47,7 @@ lists</a><br>
</li>
<li>PDF (pdf.inc)<br>
</li>
<li>Account profiles (profiles.inc)<br>
<li><a href="profiles.htm">Account profiles (profiles.inc)</a><br>
</li>
<li><a href="config.htm">Configuration (config inc)</a><br>
</li>
@ -75,7 +75,7 @@ lists</a><br>
</li>
<li>Account modules</li>
<li>PDF templates</li>
<li>Account profiles</li>
<li><a href="profile_files.htm">Account profiles</a></li>
<li><a href="config_files.html">Configuration profiles</a><br>
</li>
</ul>

View File

@ -0,0 +1,36 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-15"
http-equiv="content-type">
<title>Account profiles</title>
<link rel="stylesheet" type="text/css" href="style/layout.css">
</head>
<body>
<h1 style="text-align: center;">Account profiles</h1>
<br>
Every account profile is saved as single file in <span
style="font-weight: bold;">config/profiles</span>. The
file extension is the account type (user, group, ...).<br>
In contrast to the configuration profiles the account profiles are not
designed to be editable by hand. They do not allow to add comments and
have a simpler format.<br>
<br>
<h2>Format</h2>
There is one option per line which is formated: &lt;identifier&gt;:
&lt;value&gt;<br>
<br>
Identifier is the option's name, value is the rest of the line after
the first <span style="font-weight: bold;">": "</span>.<br>
Some options are multi-valued, the sub-values are separated by <span
style="font-weight: bold;">"+::+"</span>.<br>
<br>
<br>
<span style="font-weight: bold;">Examples:</span><br
style="font-weight: bold;">
<br>
posixAccount_primaryGroup: group1<br>
posixAccount_additionalGroup: group3+::+group4+::+group5+::+group6<br>
<br>
</body>
</html>

View File

@ -0,0 +1,25 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-15"
http-equiv="content-type">
<title>Account profiles</title>
<link rel="stylesheet" type="text/css" href="style/layout.css">
</head>
<body>
<h1 style="text-align: center;">profiles.inc</h1>
<br>
This file includes all functions to manage <a href="profile_files.htm">account
profiles</a>. You can read/store/list/delete profiles.<br>
<br>
Profile names may contain letters, numbers, "_" and "-". All functions
which have a profile name as parameter check this.<br>
Functions which modify the filesystem (<span style="font-style: italic;">saveAccountProfile,
delAccountProfile</span>) also check if the user is logged in to LAM
for security reasons. This is done by reading <span
style="font-style: italic;">$_SESSION['logedIn']</span>.<br>
<br>
<br>
<br>
</body>
</html>