diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-12-09 17:43:46 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-12-09 17:43:46 +0200 |
commit | 0711072135b526c33086175f5e5a82a201b207ac (patch) | |
tree | d9604bfa37143c9a83590a8ae7e089e0a69fc800 /doc/wydawca.texi | |
parent | aecebd653ebb3751d2680a80bd49bcd1ed00ba62 (diff) | |
download | wydawca-0711072135b526c33086175f5e5a82a201b207ac.tar.gz wydawca-0711072135b526c33086175f5e5a82a201b207ac.tar.bz2 |
Improve docs + bugfix.
* doc/Makefile.am (check-options): Fix sed expression.
* doc/wydawca.texi: Update.
* src/job.c (job_start): Don't fork if single_process is set.
Diffstat (limited to 'doc/wydawca.texi')
-rw-r--r-- | doc/wydawca.texi | 277 |
1 files changed, 171 insertions, 106 deletions
diff --git a/doc/wydawca.texi b/doc/wydawca.texi index 82b8403..a136fd6 100644 --- a/doc/wydawca.texi +++ b/doc/wydawca.texi | |||
@@ -113,10 +113,8 @@ Access Methods | |||
113 | 113 | ||
114 | SQL Access Methods | 114 | SQL Access Methods |
115 | 115 | ||
116 | * gpg-key-sql:: | ||
117 | * project-owner-sql:: | 116 | * project-owner-sql:: |
118 | * user-data-sql:: | 117 | * project-uploader-sql:: |
119 | * verify-user-sql:: | ||
120 | 118 | ||
121 | Mail Notification | 119 | Mail Notification |
122 | 120 | ||
@@ -372,7 +370,7 @@ reports them on its error output and exits with a non-zero status. | |||
372 | other inconsistencies and to exit with status 0 if no errors were | 370 | other inconsistencies and to exit with status 0 if no errors were |
373 | detected, and withs status 1 otherwise. | 371 | detected, and withs status 1 otherwise. |
374 | 372 | ||
375 | @opindex -E, introduced | 373 | @sopindex{E, introduced} |
376 | @xopindex{no-preprocessor, introduced} | 374 | @xopindex{no-preprocessor, introduced} |
377 | Before parsing, configuration file is preprocessed using | 375 | Before parsing, configuration file is preprocessed using |
378 | @command{m4} (@pxref{Preprocessor}). To see the preprocessed | 376 | @command{m4} (@pxref{Preprocessor}). To see the preprocessed |
@@ -748,21 +746,48 @@ diagnostic. An initial set of macro definitions is supplied by the | |||
748 | @file{@var{$prefix}/share/wydawca/@var{version}/include} directory (where | 746 | @file{@var{$prefix}/share/wydawca/@var{version}/include} directory (where |
749 | @var{version} means the version of Wydawca package). | 747 | @var{version} means the version of Wydawca package). |
750 | 748 | ||
751 | The default @file{pp-setup} file renames all @command{m4} built-in | 749 | The default @file{pp-setup} file renames all @command{m4} built-in |
752 | macro names so they all start with the prefix @samp{m4_}. This | 750 | macro names so they all start with the prefix @samp{m4_}. This |
753 | is similar to GNU m4 @option{--prefix-builtin} options, but has an | 751 | is similar to GNU m4 @option{--prefix-builtin} options, but has an |
754 | advantage that it works with non-GNU @command{m4} implementations as | 752 | advantage that it works with non-GNU @command{m4} implementations as |
755 | well. | 753 | well. |
754 | |||
755 | Additional control over the preprocessor is provided via the | ||
756 | following command line options: | ||
757 | |||
758 | @table @option | ||
759 | @xopindex{define, introduced} | ||
760 | @sopindex{D, introduced} | ||
761 | @item --define=@var{name}[=@var{value}] | ||
762 | @itemx -D@var{name}[=@var{value}] | ||
763 | Define the preprocessor symbol @var{name} as having @var{value}, or | ||
764 | empty. | ||
765 | |||
766 | @xopindex{include-directory, introduced} | ||
767 | @sopindex{I, introduced} | ||
768 | @item --include-directory=@var{dir} | ||
769 | @itemx -I@var{dir} | ||
770 | Add @var{dir} to the list of directories searched for preprocessor | ||
771 | include files. | ||
772 | |||
773 | @xopindex{no-preprocessor, defined} | ||
774 | @item --no-preprocessor | ||
775 | Disable preprocessor. | ||
776 | |||
777 | @xopindex{preprocessor, defined} | ||
778 | @item --preprocessor=@var{command} | ||
779 | Use @var{command} instead of the default preprocessor. | ||
780 | @end table | ||
756 | 781 | ||
757 | @node syslog | 782 | @node syslog |
758 | @section Syslog Configuration Directives | 783 | @section Syslog Configuration Directives |
759 | @cindex syslog, configuration | 784 | @cindex syslog, configuration |
760 | @kwindex syslog | ||
761 | 785 | ||
762 | Unless told otherwise, @command{wydawca} uses @code{syslog} to print | 786 | Unless told otherwise, @command{wydawca} uses @code{syslog} to print |
763 | its diagnostic messages. By default, the program uses the | 787 | its diagnostic messages. By default, the program uses the |
764 | @samp{local1} facility. The @code{syslog} statement allows to change that: | 788 | @samp{local1} facility. The @code{syslog} statement allows to change that: |
765 | 789 | ||
790 | @deffn {Config} syslog @{ ... @} | ||
766 | @smallexample | 791 | @smallexample |
767 | syslog @{ | 792 | syslog @{ |
768 | facility local1; | 793 | facility local1; |
@@ -770,6 +795,8 @@ syslog @{ | |||
770 | print-priority yes; | 795 | print-priority yes; |
771 | @} | 796 | @} |
772 | @end smallexample | 797 | @end smallexample |
798 | @end deffn | ||
799 | |||
773 | 800 | ||
774 | @deffn {Config: syslog} facility @var{name} | 801 | @deffn {Config: syslog} facility @var{name} |
775 | @kwindex authpriv@r{, syslog facility} | 802 | @kwindex authpriv@r{, syslog facility} |
@@ -816,10 +843,9 @@ databases simultaneously, the only restriction being that they must be | |||
816 | @command{MySQL} databases (this restriction will be removed in future | 843 | @command{MySQL} databases (this restriction will be removed in future |
817 | releases). | 844 | releases). |
818 | 845 | ||
819 | @kwindex sql | 846 | A database is defined using @code{sql} block statement: |
820 | A database is defined using @code{sql} block statement. It has the | ||
821 | following syntax: | ||
822 | 847 | ||
848 | @deffn {Config} sql @var{id} @{ ... @} | ||
823 | @smallexample | 849 | @smallexample |
824 | @group | 850 | @group |
825 | sql @var{id} @{ | 851 | sql @var{id} @{ |
@@ -827,6 +853,7 @@ sql @var{id} @{ | |||
827 | database @var{dbname}; | 853 | database @var{dbname}; |
828 | user @var{username}; | 854 | user @var{username}; |
829 | password @var{string}; | 855 | password @var{string}; |
856 | ssl-ca @var{string}; | ||
830 | @} | 857 | @} |
831 | @end group | 858 | @end group |
832 | @end smallexample | 859 | @end smallexample |
@@ -835,6 +862,7 @@ sql @var{id} @{ | |||
835 | database. It is used by another configuration statements (e.g. by | 862 | database. It is used by another configuration statements (e.g. by |
836 | access methods, see the next section) to refer to this | 863 | access methods, see the next section) to refer to this |
837 | database. | 864 | database. |
865 | @end deffn | ||
838 | 866 | ||
839 | @deffn {Config: sql} host @var{hostname}[:@var{port-or-socket}] | 867 | @deffn {Config: sql} host @var{hostname}[:@var{port-or-socket}] |
840 | Set the hostname or @acronym{IP} address of the host running the | 868 | Set the hostname or @acronym{IP} address of the host running the |
@@ -857,6 +885,11 @@ Sets the database user name. | |||
857 | Sets the password for accessing the database. | 885 | Sets the password for accessing the database. |
858 | @end deffn | 886 | @end deffn |
859 | 887 | ||
888 | @deffn {Config: sql} ssl-ca @var{file} | ||
889 | Sets the pathname to the certificate authority file, if you | ||
890 | wish to use a secure connection to the server via SSL. | ||
891 | @end deffn | ||
892 | |||
860 | @noindent | 893 | @noindent |
861 | An example @code{sql} statement follows: | 894 | An example @code{sql} statement follows: |
862 | 895 | ||
@@ -875,14 +908,15 @@ sql default @{ | |||
875 | @section Access Methods | 908 | @section Access Methods |
876 | @cindex Access method | 909 | @cindex Access method |
877 | @cindex @acronym{PGP} key | 910 | @cindex @acronym{PGP} key |
878 | @UNREVISED | 911 | |
879 | An @dfn{access method} defines the ways to retrieve user information | 912 | An @dfn{access method} defines the ways to retrieve user information |
880 | needed to verify the submission. This information can be, for example, | 913 | necessary to verify the submission. This information can be, for |
881 | the user's @acronym{PGP} key or his permissions on a project. | 914 | example, the user's @acronym{PGP} key or his permissions on a project. |
882 | 915 | ||
883 | Access methods are defined in configuration file using the | 916 | Access methods are defined in configuration file using the |
884 | following syntax: | 917 | following syntax: |
885 | 918 | ||
919 | @deffn {Config} access-method | ||
886 | @smallexample | 920 | @smallexample |
887 | access-method @var{method-name} @{ | 921 | access-method @var{method-name} @{ |
888 | type @var{type}; | 922 | type @var{type}; |
@@ -890,6 +924,7 @@ access-method @var{method-name} @{ | |||
890 | params (@var{param1},@var{param2},...); | 924 | params (@var{param1},@var{param2},...); |
891 | @} | 925 | @} |
892 | @end smallexample | 926 | @end smallexample |
927 | @end deffn | ||
893 | 928 | ||
894 | Access method statements can appear either in the global scope of | 929 | Access method statements can appear either in the global scope of |
895 | the configuration file, or inside a @code{spool} statement | 930 | the configuration file, or inside a @code{spool} statement |
@@ -897,15 +932,10 @@ the configuration file, or inside a @code{spool} statement | |||
897 | pairs in the configuration file, and ones inside a @code{directory} | 932 | pairs in the configuration file, and ones inside a @code{directory} |
898 | statement override them for that particular directory pair. | 933 | statement override them for that particular directory pair. |
899 | 934 | ||
900 | There are four access methods, identified by the value of | 935 | There are two access methods, identified by the value of |
901 | @var{method-name} tag: | 936 | @var{method-name} tag: |
902 | 937 | ||
903 | @table @asis | 938 | @table @asis |
904 | @kwindex gpg-key | ||
905 | @item gpg-key | ||
906 | Retrieve the public @acronym{PGP} key of a user. This method must | ||
907 | return exactly one string. | ||
908 | |||
909 | @kwindex project-owner | 939 | @kwindex project-owner |
910 | @item project-owner | 940 | @item project-owner |
911 | Retrieve email addresses and real names of administrators (or | 941 | Retrieve email addresses and real names of administrators (or |
@@ -913,17 +943,10 @@ return exactly one string. | |||
913 | consisting of two columns: an email address and a user name, in this | 943 | consisting of two columns: an email address and a user name, in this |
914 | order. | 944 | order. |
915 | 945 | ||
916 | @kwindex user-data | 946 | @kwindex project-uploader |
917 | @item user-data | 947 | @item project-uploader |
918 | Return email address and real name of a user. This method must | 948 | Return system user names, real names, emails and GPG keys of |
919 | return one tuple, consisting of two columns: an email address and a user | 949 | the users that are allowed to make uploads for the project. |
920 | name, in this order. | ||
921 | |||
922 | @kwindex verify-user | ||
923 | @item verify-user | ||
924 | Verify if a user is allowed to make uploads for a certain project. This | ||
925 | method must return the system name of the user if he is allowed to | ||
926 | make uploads. | ||
927 | @end table | 950 | @end table |
928 | 951 | ||
929 | The sub-statements of @code{access-method} are: | 952 | The sub-statements of @code{access-method} are: |
@@ -956,13 +979,6 @@ subject to meta-variable interpretation (@pxref{meta-interpretation}). The | |||
956 | following meta-variables are defined: | 979 | following meta-variables are defined: |
957 | 980 | ||
958 | @table @code | 981 | @table @code |
959 | @kwindex u | ||
960 | @kwindex user | ||
961 | @ite |