OSSP CVS Repository

ossp - Check-in [342]
Not logged in
[Honeypot]  [Browse]  [Home]  [Login]  [Reports
[Search]  [Ticket]  [Timeline
  [Patchset]  [Tagging/Branching

Check-in Number: 342
Date: 2001-Jan-20 14:34:57 (local)
2001-Jan-20 13:34:57 (UTC)
User:rse
Branch:
Comment: Add first cut for a petidomo(1) manual page.
Tickets:
Inspections:
Files:
ossp-pkg/petidomo/.cvsignore      1.1 -> 1.2     1 inserted, 0 deleted
ossp-pkg/petidomo/Makefile.in      1.38 -> 1.39     15 inserted, 1 deleted
ossp-pkg/petidomo/petidomo.pod      added-> 1.1

ossp-pkg/petidomo/.cvsignore 1.1 -> 1.2

--- .cvsignore   2000/12/14 15:09:16     1.1
+++ .cvsignore   2001/01/20 13:34:57     1.2
@@ -1,3 +1,4 @@
 configure config.log config.cache config.status Makefile
 acl.c acl_scan.c acl_scan.h
 petidomo
+petidomo.1


ossp-pkg/petidomo/Makefile.in 1.38 -> 1.39

--- Makefile.in  2001/01/20 13:26:00     1.38
+++ Makefile.in  2001/01/20 13:34:57     1.39
@@ -9,6 +9,7 @@
 datadir         = @datadir@/petidomo
 sysconfdir      = @sysconfdir@
 localstatedir   = @localstatedir@/petidomo
+mandir          = @mandir@
 
 CC              = @CC@
 AR              = ar
@@ -44,9 +45,19 @@
 .c.o:
         $(CC) $(CFLAGS) $(CPPFLAGS) -c $<
 
+all: petidomo petidomo.1
+
 petidomo:       $(OBJS) $(LIBS)
         $(CC) $(OBJS) -o $@ $(LDFLAGS) $(LIBS)
 
+petidomo.1:     petidomo.pod
+        V=`$(SHTOOL) version -lc -dlong version.c`; \
+        sed -e "s;@V@;$$V;g" <petidomo.pod >/tmp/petidomo.pod; \
+        pod2man --section=1 --date="$$V" \
+                --center="Petidomo" --release="Petidomo" \
+                /tmp/petidomo.pod >petidomo.1; \
+        rm -f /tmp/petidomo.pod
+
 acl.c acl_scan.h:       acl.y
         $(YACC) -d -p acl acl.y
         mv y.tab.c acl.c
@@ -64,16 +75,18 @@
         cd $$subdir && $(MAKE) $(FLAGS_TO_PASS); \
         echo "<=== $$subdir"
 
-install:        petidomo
+install:        all
         $(SHTOOL) mkdir -f -p -m 755 $(bindir)
         $(SHTOOL) mkdir -f -p -m 755 $(sysconfdir)
         $(SHTOOL) mkdir -f -p -m 755 $(localstatedir)/lists
         $(SHTOOL) mkdir -f -p -m 755 $(localstatedir)/ack_queue
         $(SHTOOL) mkdir -f -p -m 755 $(datadir)
         $(SHTOOL) mkdir -f -p -m 755 $(libexecdir)
+        $(SHTOOL) mkdir -f -p -m 755 $(mandir)/man1
         $(SHTOOL) install -c -s -m 555 petidomo $(bindir)
         $(SHTOOL) install -c -m 755 petidomo-approve $(bindir)
         $(SHTOOL) install -c -m 755 petidomo-kickout $(bindir)
+        $(SHTOOL) install -c -m 644 petidomo.1 $(mandir)/man1/petidomo.1
         $(SHTOOL) install -c -m 644 config/petidomo.conf $(sysconfdir)/petidomo.conf-sample
         $(SHTOOL) install -c -m 644 config/petidomo.acl $(sysconfdir)/petidomo.acl-sample
         $(SHTOOL) install -c -m 444 config/help $(datadir)
@@ -99,6 +112,7 @@
 
 clean::
         rm -f petidomo
+        rm -f petidomo.1
         rm -f $(OBJS)
         rm -f acl_scan.c acl_scan.h acl.c
 


ossp-pkg/petidomo/petidomo.pod -> 1.1

*** /dev/null    Mon Apr 29 01:52:11 2024
--- -    Mon Apr 29 01:53:23 2024
***************
*** 0 ****
--- 1,126 ----
+ ##
+ ##  petidomo.pod -- Petidomo Unix Manual Page
+ ##  Copyright (c) 2001 Ralf S. Engelschall <rse@engelschall.com> 
+ ##
+ ##  This file is part of Petidomo.
+ ##
+ ##  Petidomo 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, or (at your option)
+ ##  any later version.
+ ##
+ ##  Petidomo 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.
+ ##
+ 
+ =pod
+ 
+ =head1 NAME
+ 
+ B<petidomo> -- Mailing List Manager
+ 
+ =head1 VERSION
+ 
+ OSSP Petidomo @V@
+ 
+ =head1 SYNOPSIS
+ 
+ B<petidomo>
+ [B<--mode=>I<MODE>]
+ [B<--listname=>I<NAME>]
+ [B<--masterconf=>I<FILE>]
+ [B<--approved>]
+ 
+ =head1 DESCRIPTION
+ 
+ B<Petidomo> is a mailing list manager very similar to the popular
+ package B<Majordomo>. It handles both list un-/subscription and the
+ address expansion of list postings. The actual delivery of postings is
+ still performed by an MTA like B<Sendmail>.
+ 
+ B<Petidomo> provides only the most important features of B<Majordomo>, but
+ is 
+ 
+ =head1 COMMAND LINE OPTIONS
+ 
+ The C<petidomo> program provides the following command line options:
+ 
+ =over 4
+ 
+ =item B<--masterconf>=I<FILE>
+ 
+ The path to the global B<Petidomo> configuration file.
+ 
+ =item B<--mode>=I<MODE>
+ 
+ ...
+ 
+ =item B<--listname>=I<NAME>
+ 
+ ...
+ 
+ =item B<--approved>
+ 
+ ...
+ 
+ =back
+ 
+ =head1 CONFIGURATION
+ 
+ =head2 Global Configuration
+ 
+ The global B<Petidomo> configuration provides the following directives:
+ 
+ =over 4
+ 
+ =item B<Hostname> I<string>
+ 
+ This entry specifies the fully qualified domain name, B<Petidomo>
+ should use. This will usually be the FQDN of the machine the software
+ is running on. This option is mandatory. B<Petidomo> will abort with an
+ error, if it is unset. Example: C<Hostname petidomo.example.org>
+ 
+ =item B<AdminPassword> I<string>
+ 
+ This tag sets the master password, which authenticiates the
+ administrator of the package. Please chose this password carefully.
+ Knowledge of the master password will enable you to access ALL mailing
+ lists running on this system. Passwords are always case-insensitive.
+ This option is mandatory. B<Petidomo> will abort with an error, if it is
+ unset. Example: C<AdminPassword "open sesame">
+ 
+ =item ...
+ 
+ =back
+ 
+ =head2 List Configuration
+ 
+ =head2 Access Control Lists (ACL)
+ 
+ =head1 EXAMPLE
+ 
+ =head2 Sendmail Configuration
+ 
+ C<aliases>:
+ 
+ =head2 Petidomo Global Configuration
+ 
+ C<petidomo.conf>:
+ 
+ C<petidomo.acl>:
+ 
+ =head2 Petidomo List Configuration
+ 
+ Petidomo C<foo.conf>:
+ 
+ =head1 HISTORY
+ 
+ =head1 AUTHOR
+ 
+ Peter Simons
+ <simons@computer.org>
+ 
+ =cut
+ 

CVSTrac 2.0.1