Commit 9c7b4047 authored by Benoit Mortier's avatar Benoit Mortier
Browse files

corrected pod documentation on fusiondirectory-setup

parent bf3ac00a
dev 6342-update-the-locales-for-1-5 6344-template-issue-when-creating-a-template-with-empty-password-error-message-should-not-be-seen 6365-core-locking-mechanism-is-not-changing-the-mail-ressource-it-does-lock-the-mail-account 6365-core-when-lock-mechanism-is-trigger-the-user-should-not-be-editable-if-not-unlock 6378-orcid-test-method-is-wrong-and-break-orcid-saving 6388-clear-the-tokens-storage-issues-into-the-fusiondirectory-configuration-backend core-php8 master fusiondirectory-1.5 fusiondirectory-1.4 fusiondirectory-1.3.1 fusiondirectory-1.3 fusiondirectory-1.2.3 fusiondirectory-1.2.2 fusiondirectory-1.2.1 fusiondirectory-1.2 fusiondirectory-1.1.1 fusiondirectory-1.1 fusiondirectory-1.0.20 fusiondirectory-1.0.19 fusiondirectory-1.0.18 fusiondirectory-1.0.17 fusiondirectory-1.0.16 fusiondirectory-1.0.15 fusiondirectory-1.0.14 fusiondirectory-1.0.13 fusiondirectory-1.0.12 fusiondirectory-1.0.11 fusiondirectory-1.0.10 fusiondirectory-1.0.9.3 fusiondirectory-1.0.9.2 fusiondirectory-1.0.9.1 fusiondirectory-1.0.9 fusiondirectory-1.0.8.9 fusiondirectory-1.0.8.8 fusiondirectory-1.0.8.7 fusiondirectory-1.0.8.6 fusiondirectory-1.0.8.5 fusiondirectory-1.0.8.4 fusiondirectory-1.0.8.3 fusiondirectory-1.0.8.2 fusiondirectory-1.0.8.1 fusiondirectory-1.0.8 fusiondirectory-1.0.7.5 fusiondirectory-1.0.7.4 fusiondirectory-1.0.7.3 fusiondirectory-1.0.7.2 fusiondirectory-1.0.7.1 fusiondirectory-1.0.7 fusiondirectory-1.0.6 fusiondirectory-1.0.5 fusiondirectory-1.0.4 fusiondirectory-1.0.3 fusiondirectory-1.0.2
No related merge requests found
Showing with 78 additions and 73 deletions
+78 -73
#!/usr/bin/perl #!/usr/bin/perl
#
# This code is part of FusionDirectory (http://www.fusiondirectory.org/)
# Copyright (C) 2011 FusionDirectory
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
#
use strict; use strict;
use warnings; use warnings;
...@@ -860,8 +878,7 @@ __END__ ...@@ -860,8 +878,7 @@ __END__
=head1 NAME =head1 NAME
fusiondirectory-setup fusiondirectory-setup - Setup command to do various checks and update on FusionDirectory
=head1 DESCRIPTION =head1 DESCRIPTION
...@@ -895,11 +912,22 @@ This option check your LDAP tree. Looking for admin account, and groups or peopl ...@@ -895,11 +912,22 @@ This option check your LDAP tree. Looking for admin account, and groups or peopl
=back =back
=head1 COPYRIGHTS =head1 BUGS
Please report any bugs, or post any suggestions, to the fusiondirectory mailing list fusiondirectory-users or to
<https://forge.fusiondirectory.org/projects/fdirectory/issues/new>
=head1 LICENCE AND COPYRIGHT
This code is part of FusionDirectory (http://www.fusiondirectory.org/)
=over 2
This code is part of FusionDirectory (http://www.fusiondirectory.org/) =item Copyright (C) 2007 Fabian Hickert
Copyright (C) 2007 Fabian Hickert
Copyright (C) 2011 FusionDirectory =item Copyright (C) 2011 FusionDirectory
=back
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
...@@ -916,3 +944,4 @@ This option check your LDAP tree. Looking for admin account, and groups or peopl ...@@ -916,3 +944,4 @@ This option check your LDAP tree. Looking for admin account, and groups or peopl
Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
=cut =cut
...@@ -124,40 +124,61 @@ ...@@ -124,40 +124,61 @@
.\" ======================================================================== .\" ========================================================================
.\" .\"
.IX Title "FUSIONDIRECTORY-SETUP 1" .IX Title "FUSIONDIRECTORY-SETUP 1"
.TH FUSIONDIRECTORY-SETUP 1 "2011-08-10" "FusionDirectory 1.0" "FusionDirectory Documentation" .TH FUSIONDIRECTORY-SETUP 1 "2011-09-07" "FusionDirectory 1.0" "FusionDirectory Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents. .\" way too many mistakes in technical documents.
.if n .ad l .if n .ad l
.nh .nh
.SH "NAME" .SH "NAME"
fusiondirectory\-setup \- class cache and locale setup for FusionDirectory fusiondirectory\-setup \- Setup command to do various checks and update on FusionDirectory
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
fusiondirectory-setup [\s-1OPTION\s0]
.SH "DESCRIPTION" .SH "DESCRIPTION"
.IX Header "DESCRIPTION" .IX Header "DESCRIPTION"
fusiondirectory-setup is a command that help you to manage your fusiondirectory instance This script is designed to perform multiple checks on your FusionDirectory/LDAP architecture, and fix usual misconfiguration.
.IP "\fBrescan\-i18n\fR Rebuilds the translations" 3 For now, it update internalization, FusionDirectory's cache, it check FusionDirectory's files/directories, and it check your \s-1LDAP\s0 tree.
.IX Item "rescan-i18n Rebuilds the translations" .SS "Options"
.PD 0 .IX Subsection "Options"
.IP "\fBrescan-classes\fR Rebuilds the class list" 3 .IP "\-\-update\-cache" 4
.IX Item "rescan-classes Rebuilds the class list" .IX Item "--update-cache"
.PD This option update the /var/cache/fusiondirectory/class.cache file. Wich contain \s-1PHP\s0 classes used in FusionDirectory, and their location.
.IP "\-\-update\-lang" 4
.IX Item "--update-lang"
This option update internalization, by generating a new .mo locales file for each language, with every .po files it found.
Needs \fImsgcat\fR and \fImsgfmt\fR to be installed.
.IP "\-\-check\-dir" 4
.IX Item "--check-dir"
This option perform a check on all FusionDirectory's files or directories.
.IP "\-\-create\-dir" 4
.IX Item "--create-dir"
This option fix rights misconfiguration on FusionDirectory's files or directories. It create directories that should exist but don't seem to.
.IP "\-\-check\-ldap" 4
.IX Item "--check-ldap"
This option check your \s-1LDAP\s0 tree. Looking for admin account, and groups or people branch. If one of those don't exists, the script will ask you what to do.
.SH "BUGS" .SH "BUGS"
.IX Header "BUGS" .IX Header "BUGS"
Please report any bugs, or post any suggestions, to the fusiondirectory mailing list fusiondirectory-users or to Please report any bugs, or post any suggestions, to the fusiondirectory mailing list fusiondirectory-users or to
<https://forge.fusiondirectory.org/projects/fdirectory/issues/new> <https://forge.fusiondirectory.org/projects/fdirectory/issues/new>
.SH "LICENCE AND COPYRIGHT" .SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT" .IX Header "LICENCE AND COPYRIGHT"
This code is part of FusionDirectory <http://www.fusiondirectory.org> This code is part of FusionDirectory (http://www.fusiondirectory.org/)
.IP "Copyright (C) 2003\-2010 \s-1GONICUS\s0 GmbH" 2 .IP "Copyright (C) 2007 Fabian Hickert" 2
.IX Item "Copyright (C) 2003-2010 GONICUS GmbH" .IX Item "Copyright (C) 2007 Fabian Hickert"
.PD 0 .PD 0
.IP "Copyright (C) 2011 FusionDirectory Project" 2 .IP "Copyright (C) 2011 FusionDirectory" 2
.IX Item "Copyright (C) 2011 FusionDirectory Project" .IX Item "Copyright (C) 2011 FusionDirectory"
.PD .PD
.PP .PP
This program is distributed in the hope that it will be useful, .Vb 4
but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of \& This program is free software; you can redistribute it and/or modify
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the \& it under the terms of the GNU General Public License as published by
\&\s-1GNU\s0 General Public License for more details. \& the Free Software Foundation; either version 2 of the License, or
\& (at your option) any later version.
\&
\& This program is distributed in the hope that it will be useful,
\& but WITHOUT ANY WARRANTY; without even the implied warranty of
\& MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\& GNU General Public License for more details.
\&
\& You should have received a copy of the GNU General Public License
\& along with this program; if not, write to the Free Software
\& Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110\-1301, USA.
.Ve
=head1 NAME
fusiondirectory-setup - class cache and locale setup for FusionDirectory
=head1 SYNOPSIS
fusiondirectory-setup [OPTION]
=head1 DESCRIPTION
fusiondirectory-setup is a command that help you to manage your fusiondirectory instance
=over 3
=item B<rescan-i18n> Rebuilds the translations
=item B<rescan-classes> Rebuilds the class list
=back
=head1 BUGS
Please report any bugs, or post any suggestions, to the fusiondirectory mailing list fusiondirectory-users or to
<https://forge.fusiondirectory.org/projects/fdirectory/issues/new>
=head1 LICENCE AND COPYRIGHT
This code is part of FusionDirectory <http://www.fusiondirectory.org>
=over 2
=item Copyright (C) 2003-2010 GONICUS GmbH
=item Copyright (C) 2011 FusionDirectory Project
=back
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
=cut
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment