[Refdb-cvs] CVS: refdb/doc refdb-manual-chapter1.sgml,1.12.2.3,1.12.2.4 refdb-manual-chapter10.sgml,
Status: Beta
Brought to you by:
mhoenicka
Menu
▾
▴
[Refdb-cvs] CVS: refdb/doc refdb-manual-chapter1.sgml,1.12.2.3,1.12.2.4 refdb-manual-chapter10.sgml,1.19.2.4,1.19.2.5 refdb-manual-chapter5.sgml,1.24.2.7,1.24.2.8 refdb-manual-chapter7.sgml,1.16.2.4,1.16.2.5 refdb-manual-chapter8.sgml,1.13.2.5,1.13.2.6 refdb-manual-chapter9.sgml,1.15.2.2,1.15.2.3 refdb-manual-configopts.sgml,1.4.2.5,1.4.2.6
|
From: Markus H. <mho...@us...> - 2005-11-14 20:17:33
|
Update of /cvsroot/refdb/refdb/doc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16967/doc Modified Files: Tag: Release_0_9_5_stable refdb-manual-chapter1.sgml refdb-manual-chapter10.sgml refdb-manual-chapter5.sgml refdb-manual-chapter7.sgml refdb-manual-chapter8.sgml refdb-manual-chapter9.sgml refdb-manual-configopts.sgml Log Message: updated for 0.9.6 Index: refdb-manual-chapter1.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter1.sgml,v retrieving revision 1.12.2.3 retrieving revision 1.12.2.4 diff -u -U2 -r1.12.2.3 -r1.12.2.4 --- refdb-manual-chapter1.sgml 14 Aug 2005 00:18:27 -0000 1.12.2.3 +++ refdb-manual-chapter1.sgml 14 Nov 2005 20:17:18 -0000 1.12.2.4 @@ -45,4 +45,7 @@ <para>The &appname; clients can be run in an interactive mode or in a batch mode which is useful in scripts.</para> </listitem> + <listitem> + <para>Separately available packages integrate &appname; functionality into Emacs and vim, turning these editors into integrated authoring environments for DocBook and TEI documents with easy access to your reference data.</para> + </listitem> <listitem> <para>The adepts of the Perl programming language might be delighted to know that the RefDBClient module allows Perl programs to directly communicate with a &appname;d server without using the C clients. This allows the rapid development of custom programs that access RefDB databases.</para> Index: refdb-manual-chapter10.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter10.sgml,v retrieving revision 1.19.2.4 retrieving revision 1.19.2.5 diff -u -U2 -r1.19.2.4 -r1.19.2.5 --- refdb-manual-chapter10.sgml 14 Aug 2005 00:18:27 -0000 1.19.2.4 +++ refdb-manual-chapter10.sgml 14 Nov 2005 20:17:18 -0000 1.19.2.5 @@ -207,5 +207,4 @@ <arg>-O <replaceable>outfile</replaceable></arg> </group> - <arg choice="opt" rep="norepeat">-r</arg> <arg choice="req" rep="norepeat">note-specifier</arg> <arg choice="req" rep="repeat">link-target</arg> @@ -214,5 +213,5 @@ <simplesect> <title>Description</title> - <para>The <command moreinfo="none">addlink</command> command links an extended note to one or more link targets. If you use the <option>-r</option> option, the specified links will be removed.</para> + <para>The <command moreinfo="none">addlink</command> command links an extended note to one or more link targets.</para> <para>You have to specify exactly one note on the command line, either by using the :NID: field selector to specify the note ID, or by using the :NCK: field selector to specify the note key. Then you need at least one link target. This can be one of :ID: (reference by ID), :CK: (reference by citation key), :AU: (author by name), :KW: (keyword by name), or one of :JF:, :JO:, :J1:, :J2: (periodical by full name, abbreviated name, or user abbreviations 1 and 2).</para> </simplesect> @@ -236,9 +235,6 @@ <arg>-o <replaceable>outfile</replaceable></arg> <arg>-O <replaceable>outfile</replaceable></arg> - </group> - <group choice="req" rep="repeat"> + </group> <arg rep="repeat"><replaceable>file</replaceable></arg> - <arg>-f <replaceable>infile</replaceable></arg> - </group> </cmdsynopsis> </simplesect> @@ -251,6 +247,5 @@ <para>The <option>-h</option> option displays a short command syntax and description, then returns to the command prompt. </para> <para>The <option>-o</option> and <option>-O</option> switches allow to redirect the output to <filename>outfile</filename> instead of the default screen display. The two options differ in the way they handle an existing <filename>outfile</filename>. <option>-o</option> will replace the existing file, while <option>-O</option> will append to the existing file. If <filename>outfile</filename> cannot be opened with the proper permissions, the output is sent to stdout instead.</para> - <para>The <option>-f</option> switch allows to specify a file which contains a whitespace-separated list of filenames instead of explicitly naming these files on the command line.</para> - <para>All other command-line arguments will be interpreted as filenames to read references from. If data are available on stdin, all files will be ignored and the data will be read from stdin.</para> + <para>All other command-line arguments will be interpreted as filenames to read references from. If no filenames are specified, the data will be read from stdin.</para> </simplesect> <simplesect> @@ -277,8 +272,5 @@ <arg choice="opt" rep="norepeat">-t <replaceable>type</replaceable></arg> <arg choice="opt" rep="norepeat">-U <replaceable>username</replaceable></arg> - <group choice="req" rep="repeat"> <arg rep="repeat"><replaceable>file</replaceable></arg> - <arg>-f <replaceable>infile</replaceable></arg> - </group> </cmdsynopsis> </simplesect> @@ -302,6 +294,5 @@ <para>The <option>-o</option> and <option>-O</option> switches allow to redirect the output to <filename>outfile</filename> instead of the default screen display. The two options differ in the way they handle an existing <filename>outfile</filename>. <option>-o</option> will replace the existing file, while <option>-O</option> will append to the existing file. If <filename>outfile</filename> cannot be opened with the proper permissions, the output is sent to stdout instead.</para> <para>The <option>-U</option> switch allows to provide a different username than the current user, so e.g. some technician or administrative staff can add references in behalf of a researcher.</para> - <para>The <option>-f</option> switch allows to specify a file which contains a whitespace-separated list of filenames instead of explicitly naming these files on the command line.</para> - <para>All other command-line arguments will be interpreted as filenames to read references from. If data are available on stdin, all files will be ignored and the data will be read from stdin.</para> + <para>All other command-line arguments will be interpreted as filenames to read references from. If no filenames are specified, the data will be read from stdin.</para> </simplesect> <simplesect> @@ -312,4 +303,32 @@ </simplesect> </sect2> + <sect2 id="app-c-command-deletelink"> + <title>deletelink</title> + <simplesect> + <title>Synopsis</title> + <cmdsynopsis> + <command>deletelink</command> + <arg choice="opt" rep="norepeat">-d <replaceable>database</replaceable></arg> + <arg choice="opt" rep="norepeat">-h</arg> + <group choice="opt" rep="norepeat"> + <arg>-c <replaceable>command</replaceable></arg> + <arg>-o <replaceable>outfile</replaceable></arg> + <arg>-O <replaceable>outfile</replaceable></arg> + </group> + <arg choice="req" rep="norepeat">note-specifier</arg> + <arg choice="req" rep="repeat">link-target</arg> + </cmdsynopsis> + </simplesect> + <simplesect> + <title>Description</title> + <para>The <command moreinfo="none">deletelink</command> command removes links from an extended note to one or more link targets.</para> + <para>You have to specify exactly one note on the command line, either by using the :NID: field selector to specify the note ID, or by using the :NCK: field selector to specify the note key. Then you need at least one link target. This can be one of :ID: (reference by ID), :CK: (reference by citation key), :AU: (author by name), :KW: (keyword by name), or one of :JF:, :JO:, :J1:, :J2: (periodical by full name, abbreviated name, or user abbreviations 1 and 2).</para> + </simplesect> + <simplesect> + <title>Example</title> + <screen><prompt>&appname;c: </prompt><userinput>deletelink :NID:=12 :CK:=Miller1999 :KW:=biochemistry</userinput></screen> + <para>This command will delete the links from the note carrying the ID 12 to a reference specified by its citation key "Miller1999" and to the keyword "biochemistry".</para> + </simplesect> + </sect2> <sect2 id="app-c-command-deletenote"> <title>deletenote</title> @@ -334,5 +353,5 @@ <title>Description</title> <para>Deletes the extended note with the identifier <replaceable>ID</replaceable> from the current database. Several extended notes may be specified in a single call of this command. Notes with consecutive ID values may be specified as ranges.</para> - <para>Alternatively you can specify a file with the <option>-f</option> switch which contains a list of IDs in the RIS format. This can e.g. be a previously saved search with the <option>-o</option> and <option>-s ID</option> options of <command>getnote</command>. The <option>-f</option> switch can also be combined with IDs specified as arguments.</para> + <para>Alternatively you can specify a file with the <option>-f</option> switch which contains a list of IDs in the RIS format. This can e.g. be a previously saved search with the <option>-o</option> and <option>-s ID</option> options of <command>getnote</command>. The <option>-f</option> switch can also be combined with IDs specified as arguments. If no IDs are specified, the ID list is read from stdin. If you want to read from stdin <emphasis>in addition to</emphasis> other IDs, you must use the <option>-f stdin</option> option.</para> <para>The <option>-c</option> switch allows to specify a shell <command>command</command>. &appname;c will open a pipe to the first program in the command and send the output to this program's stdin. The command may be any valid command that you can run in your shell, so further plumbing is perfectly legal. This feature may e.g. be used to filter the output with grep.</para> <para>Use the <option>-d</option> option to specify the database that you want to work with.</para> @@ -371,5 +390,5 @@ <title>Description</title> <para>Deletes the reference with the identifier <replaceable>ID</replaceable> from the current database. Several references may be specified in a single call of this command. References with consecutive ID values may be specified as ranges.</para> - <para>Alternatively you can specify a file with the <option>-f</option> switch which contains a list of IDs in the RIS format. This can e.g. be a previously saved search with the <option>-o</option> and <option>-s ID</option> options of <command>getref</command>. The <option>-f</option> switch can also be combined with IDs specified as arguments.</para> + <para>Alternatively you can specify a file with the <option>-f</option> switch which contains a list of IDs in the RIS format. This can e.g. be a previously saved search with the <option>-o</option> and <option>-s ID</option> options of <command>getref</command>. The <option>-f</option> switch can also be combined with IDs specified as arguments. If no IDs are specified, the ID list is read from stdin. If you want to read an ID list from stdin <emphasis>in addition to</emphasis> IDs passed as arguments, you have to use the <option>-f stdin</option> option.</para> <para>The <option>-c</option> switch allows to specify a shell <command>command</command>. &appname;c will open a pipe to the first program in the command and send the output to this program's stdin. The command may be any valid command that you can run in your shell, so further plumbing is perfectly legal. This feature may e.g. be used to filter the output with grep.</para> <para>Use the <option>-d</option> option to specify the database that you want to work with.</para> @@ -413,5 +432,5 @@ <para>The <option>-h</option> option displays a short command syntax and description, then returns to the command prompt. </para> <para>The <option>-o</option> and <option>-O</option> switches allow to redirect the output to <filename>outfile</filename> instead of the default screen display. The two options differ in the way they handle an existing <filename>outfile</filename>. <option>-o</option> will replace the existing file, while <option>-O</option> will append to the existing file. If <filename>outfile</filename> cannot be opened with the proper permissions, the output is sent to stdout instead.</para> - <para>The references can be specified on the command line or they can be read from a file which is specified with the <replaceable>-f</replaceable> option. Both methods can be combined. The file has to be in RIS format and can e.g. be a previously saved search with the <option>-o</option> and <option>-s ID</option> options of <link linkend="app-c-command-getref"><command>getref</command></link>.</para> + <para>The references can be specified on the command line or they can be read from a file which is specified with the <replaceable>-f</replaceable> option. Both methods can be combined. The file has to be in RIS format and can e.g. be a previously saved search with the <option>-o</option> and <option>-s ID</option> options of <link linkend="app-c-command-getref"><command>getref</command></link>. If no IDs are specified as arguments, the ID list is read from stdin. If you want to read from stdin <emphasis>in addition to</emphasis> IDs specified as arguments, you have to use the <option>-f stdin</option> option.</para> </simplesect> <simplesect> @@ -616,5 +635,5 @@ <para>The <option>-P</option> switch limits the search to the notes which were added by the current user. If this switch is absent, the whole database will be searched.</para> <para>The <option>-t</option> switch determines the <link linkend="sect-output-formats">type of output</link>. The default value for <replaceable>output-format</replaceable> is <wordasword>scrn</wordasword> (screen output), other possible values are <wordasword>xnote</wordasword> (XML according to the xnote DTD), <wordasword>html</wordasword> (HTML), and <wordasword>xhtml</wordasword>.</para> - <para>The <option>-f</option> switch reads the search string from <filename>file</filename> instead of from the command line, thus allowing to save searches which will be run repeatedly.</para> + <para>The <option>-f</option> switch reads the search string from <filename>file</filename> instead of from the command line, thus allowing to save searches which will be run repeatedly. If no search string is specified, the string will be read from stdin.</para> <para>The syntax of the queries is described in the section <link linkend="sect1-query-language">query language</link>.</para> </simplesect> @@ -664,5 +683,5 @@ <para>The <option>-P</option> switch limits the search to the files which are in the current user's personal reference list. If this switch is absent, the whole database will be searched.</para> <para>The <option>-t</option> switch determines the <link linkend="sect-output-formats">type of output</link>. The default value for <replaceable>output-format</replaceable> is <wordasword>scrn</wordasword> (screen output), other possible values are <wordasword>db31</wordasword> (DocBook SGML V. 3.1), <wordasword>db31x</wordasword> (DocBook XML), <wordasword>ris</wordasword> (RIS as of Reference Manager 8.01), <wordasword>risx</wordasword> (XML according to the <link linkend="sect1-writing-risx">risx DTD</link>), <wordasword>html</wordasword> (HTML), <wordasword>xhtml</wordasword> (XHTML), and <wordasword>bibtex</wordasword> (BibTeX).</para> - <para>The <option>-f</option> switch reads the search string from <filename>file</filename> instead of from the command line, thus allowing to save searches which will be run repeatedly.</para> + <para>The <option>-f</option> switch reads the search string from <filename>file</filename> instead of from the command line, thus allowing to save searches which will be run repeatedly. If no search string is specified, the string is read from stdin.</para> <para>The syntax of the queries is described in the section <link linkend="sect1-query-language">query language</link>.</para> </simplesect> @@ -764,5 +783,5 @@ <para>The <option>-h</option> option displays a short command syntax and description, then returns to the command prompt. </para> <para>The <option>-o</option> and <option>-O</option> switches allow to redirect the output to <filename>outfile</filename> instead of the default screen display. The two options differ in the way they handle an existing <filename>outfile</filename>. <option>-o</option> will replace the existing file, while <option>-O</option> will append to the existing file. If <filename>outfile</filename> cannot be opened with the proper permissions, the output is sent to stdout instead.</para> - <para>The references can be specified on the command line or they can be read from a file which is specified with the <replaceable>-f</replaceable> option. Both methods can be combined. The file has to be in RIS format and can e.g. be a previously saved search with the <option>-o</option> and <option>-s ID</option> options of <link linkend="app-c-command-getref"><command>getref</command></link>.</para> + <para>The references can be specified on the command line or they can be read from a file which is specified with the <replaceable>-f</replaceable> option. Both methods can be combined. The file has to be in RIS format and can e.g. be a previously saved search with the <option>-o</option> and <option>-s ID</option> options of <link linkend="app-c-command-getref"><command>getref</command></link>. If no IDs are specified, the ID list in RIS format is read from stdin.</para> </simplesect> <simplesect> @@ -838,8 +857,5 @@ <arg>-O <replaceable>outfile</replaceable></arg> </group> - <group choice="req" rep="repeat"> <arg rep="repeat"><replaceable>file</replaceable></arg> - <arg>-f <replaceable>infile</replaceable></arg> - </group> </cmdsynopsis> </simplesect> @@ -874,8 +890,5 @@ <arg>-P</arg> <arg choice="opt" rep="norepeat">-U <replaceable>username</replaceable></arg> - <group choice="req" rep="repeat"> <arg><replaceable>file</replaceable></arg> - <arg>-f <replaceable>infile</replaceable></arg> - </group> </cmdsynopsis> </simplesect> Index: refdb-manual-chapter5.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter5.sgml,v retrieving revision 1.24.2.7 retrieving revision 1.24.2.8 diff -u -U2 -r1.24.2.7 -r1.24.2.8 --- refdb-manual-chapter5.sgml 21 Oct 2005 21:05:13 -0000 1.24.2.7 +++ refdb-manual-chapter5.sgml 14 Nov 2005 20:17:18 -0000 1.24.2.8 @@ -423,5 +423,5 @@ <screen format="linespecific"><prompt moreinfo="none">$~/build/&appname; </prompt><userinput moreinfo="none">./autogen.sh</userinput></screen> <note> - <para>The autotools can cause severe headaches at times. If the above command causes errors, read <filename moreinfo="none">autogen.sh</filename> and run the commands manually, substituting different versions as appropriate. E.g. substitute <command moreinfo="none">automake</command> with <command moreinfo="none">automake-1.8</command> if this gives better results. The autotools on FreeBSD 5.4 are essentially unusable, you have to install the gnu-autotools package instead. You have to modify your <envar>PATH</envar> to pick up the latter, and fiddle with the m4 macro paths in order to see the light.</para> + <para>The autotools can cause severe headaches at times. If the above command causes errors, read <filename moreinfo="none">autogen.sh</filename> and run the commands manually, substituting different versions as appropriate. E.g. substitute <command moreinfo="none">automake</command> with <command moreinfo="none">automake-1.8</command> if this gives better results. The native autotools shipped with FreeBSD 5.4 are unusable for our purposes, you have to install the gnu-autotools package instead. You have to modify your <envar>PATH</envar> to pick up the latter, and fiddle with the m4 macro paths in order to see the light.</para> </note> </step> @@ -452,4 +452,7 @@ <para><ulink url="http://xml.apache.org/batik/svgrasterizer.html">Batik SVG Rasterizer</ulink>: an image converter used to create the images from the <acronym>SVG</acronym> sources. The Makefile calls a script in your path called <filename moreinfo="none">batik-rasterizer</filename> which is supposed to run this Java application appropriately.</para> </listitem> + <listitem> + <para><ulink url="http://dtdparse.sourceforge.net">dtdparse</ulink>: A Perl script (which in turn depends on a few Perl modules, see the installation instuctions) which generates the DTD documentation.</para> + </listitem> </itemizedlist> </listitem> Index: refdb-manual-chapter7.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter7.sgml,v retrieving revision 1.16.2.4 retrieving revision 1.16.2.5 diff -u -U2 -r1.16.2.4 -r1.16.2.5 --- refdb-manual-chapter7.sgml 14 Aug 2005 00:18:28 -0000 1.16.2.4 +++ refdb-manual-chapter7.sgml 14 Nov 2005 20:17:18 -0000 1.16.2.5 @@ -176,5 +176,4 @@ <arg choice="req" rep="norepeat">-H <replaceable>host-IP</replaceable></arg> <arg choice="opt" rep="norepeat">-N <replaceable>newpassword</replaceable></arg> - <arg choice="opt" rep="repeat">-r</arg> <group choice="req" rep="norepeat"> <arg choice="opt" rep="norepeat">-f <replaceable>file</replaceable></arg> @@ -185,8 +184,8 @@ <simplesect> <title>Description</title> - <para>Grants or revokes access rights to a &appname; database to the given users. Specify the database with the <option>-d</option> option.</para> + <para>Grants access rights to a &appname; database to the given users. Specify the database with the <option>-d</option> option.</para> <note> <para>If a user is not yet known to the database server, &appname; will create an account with the default access rights (=none). If you do not specify a password for the new user with the <option>-N</option> option (see below), the user will have access to the database server with the default password "refdb". In most cases this is not a good thing.</para> - <para>A new user will automatically get access to the internal &appname; database &appname;1.</para> + <para>A new user will automatically get access to the internal &appname; database &appname;.</para> <para>Some database engines like SQLite do not support access control. The <command moreinfo="none">adduser</command> command is not supported with these engines and will just return an explanatory message.</para> </note> @@ -197,9 +196,5 @@ </note> <para>Use the <option>-N</option> option to specify the password for a new user. The password is encrypted before transferring it to the application server. If the user already exists, his password will be changed accordingly.</para> - <para>The <option>-r</option> option revokes the rights of the given users.</para> - <note> - <para>&appname; will only revoke the access rights to the particular database. It will revoke neither access rights to the internal database &appname;, nor will it revoke database server access. You can revoke access to the internal database by specifying "&appname;" with the <option>-d</option> option. To revoke access to the database server, please use the command line utilities of your database server.</para> - </note> - <para>All other arguments are interpreted as usernames. In addition to naming users explicitely, you can use the <option>-f</option> option to specify a file which contains a whitespace-separated list of usernames.</para> + <para>All other arguments are interpreted as usernames. In addition to naming users explicitly, you can use the <option>-f</option> option to specify a file which contains a whitespace-separated list of usernames. If neither a username argument nor an input file is specified, &appname;a attempts to read a whitespace-separated list of names from stdin. To force &appname;a to read from stdin <emphasis>in addition to</emphasis> explicitly named users, use the <option>-f stdin</option> option.</para> </simplesect> <simplesect> @@ -238,7 +233,7 @@ <simplesect> <title>Description</title> - <para>Most bibliography styles use standardized abbreviations of the journal names. Most data sources specify these abbreviations without dots. If the words are to be abbreviated with dots (as in "Mol. Cell Biol.") in the bibliography, &appname; needs to know which tokens in the abbreviated name are indeed abbreviated (e.g. "Mol."), and which are full words (e.g. "Cell"). To this end, &appname; keeps a list of reserved words which are known not to be abbreviations of something else. &appname; ships with a fairly complete list of such words, but if you detect errors or omissions, the <command>addword</command> command comes in handy.</para> + <para>Most bibliography styles use standardized abbreviations of the journal names. Most data sources specify these abbreviations without dots, as in "Mol Cell Biol". If the words are to be abbreviated with dots (as in "Mol. Cell Biol.") in the bibliography, &appname; needs to know which tokens in the abbreviated name are indeed abbreviated (e.g. "Mol."), and which are full words (e.g. "Cell"). To this end, &appname; keeps a list of reserved words which are known not to be abbreviations of something else. &appname; ships with a fairly complete list of such words, but if you detect errors or omissions, the <command>addword</command> command comes in handy.</para> <para>The <option>-h</option> option displays the online help about the <command>addword</command> command.</para> - <para>All other arguments are interpreted as reserved words. In addition to listing the words explicitly, you can use the <option>-f</option> option to specify a file which contains a whitespace-separated list of reserved words.</para> + <para>All other arguments are interpreted as reserved words. In addition to listing the words explicitly, you can use the <option>-f</option> option to specify a file which contains a whitespace-separated list of reserved words. If neither a word list nor an input file is specified, &appname;a attempts to read a whitespace-separated list of words from stdin. To force &appname;a to read from stdin <emphasis>in addition to</emphasis> explicitly listed words, use the <option>-f stdin</option> option.</para> <note> <para>&appname; will convert all reserved words to uppercase internally, so it does not matter in which case you provide these words.</para> @@ -337,5 +332,5 @@ <title>Description</title> <para>Creates a new database with the name <replaceable>dbname</replaceable>. Several databases may be specified in a single call of this command.</para> - <para>The <option>-E</option> option selects a character encoding for the new database. This is currently only supported by PostgreSQL (and only if PostgreSQL was built with the --enable-multibyte option). If you use a different engine, this option is ignored. Please see the documentation of your PostgreSQL installation for available encodings. The value passed with the <option>-E</option> option must be one of the encoding names that PostgreSQL uses (not the corresponding MIME name). If you do not use this option, the new database will use the default encoding of the database server unless your &appname;drc configuration file sets a default with a "db_encoding" entry.</para> + <para>The <option>-E</option> option selects a character encoding for the new database. This is currently only supported by MySQL and PostgreSQL. If you use a different engine, this option is ignored. Please see the documentation of your database engine installation for available encodings. The value passed with the <option>-E</option> option should be the <ulink url="http://www.iana.org">IANA</ulink> encoding name. If you do not use this option, the new database will use the default encoding of the database server unless your &appname;drc configuration file sets a default with a "db_encoding" entry.</para> <tip> <para>Prepend a constant string like <quote>rd</quote> to all &appname; database names. This speeds up retrieving &appname; databases with the <link linkend="app-a-command-listdb"><command>listdb</command></link> command. Use a simple regular expression like <quote>rd%</quote>.</para> @@ -344,6 +339,6 @@ <simplesect> <title>Example</title> - <screen><prompt>&appname;a: </prompt><userinput>createdb <replaceable>db1</replaceable> <replaceable>db2</replaceable></userinput></screen> - <para>This will create the databases <filename moreinfo="none">db1</filename> and <filename moreinfo="none">db2</filename>.</para> + <screen><prompt>&appname;a: </prompt><userinput>createdb <replaceable>db1</replaceable> <option>-E</option> <replaceable>UTF-8</replaceable> <replaceable>db2</replaceable></userinput></screen> + <para>This will create the databases <filename moreinfo="none">db1</filename> and <filename moreinfo="none">db2</filename> with the character encoding UTF-8.</para> </simplesect> <simplesect> @@ -422,4 +417,39 @@ </simplesect> </sect2> + <sect2 id="app-a-command-deleteuser"> + <title>deleteuser</title> + <simplesect> + <title>Synopsis</title> + <cmdsynopsis> + <command>deleteuser</command> + <arg choice="req" rep="norepeat">-d <replaceable>database</replaceable></arg> + <arg choice="opt" rep="norepeat">-h</arg> + <arg choice="req" rep="norepeat">-H <replaceable>host-IP</replaceable></arg> + <group choice="req" rep="norepeat"> + <arg choice="opt" rep="norepeat">-f <replaceable>file</replaceable></arg> + <arg choice="opt" rep="repeat"><replaceable>username</replaceable></arg> + </group> + </cmdsynopsis> + </simplesect> + <simplesect> + <title>Description</title> + <para>Revokes access rights to a &appname; database from the given users. Specify the database with the <option>-d</option> option.</para> + <note> + <para>Some database engines like SQLite do not support access control. The <command moreinfo="none">adduser</command> command is not supported with these engines and will just return an explanatory message.</para> + <para>&appname; will only revoke the access rights to the specified database. It will revoke neither access rights to the internal database &appname;, nor will it revoke database server access. You can revoke access to the internal database by specifying "&appname;" with the <option>-d</option> option. To revoke access to the database server, please use the command line utilities of your database server.</para> + </note> + <para>The <option>-h</option> option displays the online help about the <command>adduser</command> command.</para> + <para>The <option>-H</option> option takes a hostname as an argument. Access rights will be revoked only for this particular hostname. This must be the same name that you used for a previous call to <link linkend="app-a-command-adduser">adduser</link>.</para> + <note> + <para>This option is only supported by MySQL. It is ignored if you useother database engines.</para> + </note> + <para>All other arguments are interpreted as usernames. In addition to naming users explicitly, you can use the <option>-f</option> option to specify a file which contains a whitespace-separated list of usernames. If neither a username argument nor an input file is specified, &appname;a attempts to read a whitespace-separated list of names from stdin. To force &appname;a to read from stdin <emphasis>in addition to</emphasis> explicitly named users, use the <option>-f stdin</option> option.</para> + </simplesect> + <simplesect> + <title>Examples</title> + <screen><prompt>&appname;a: </prompt><userinput>deleteuser <option>-d</option> <option>-H</option> <replaceable>%</replaceable> <replaceable>db1</replaceable>jim</userinput></screen> + <para>This will revoke the access to the database <filename moreinfo="none">db1</filename> for the user jim for all but local connections.</para> + </simplesect> + </sect2> <sect2 id="app-a-command-deleteword"> <title>deleteword</title> @@ -439,5 +469,5 @@ <para>This command performs the reverse operation of <link linkend="app-a-command-addword">addword</link>. The specified reserved words will be removed from the list.</para> <para>The <option>-h</option> option displays the online help about the <command>addword</command> command.</para> - <para>All other arguments are interpreted as reserved words. In addition to listing the words explicitly, you can use the <option>-f</option> option to specify a file which contains a whitespace-separated list of reserved words.</para> + <para>All other arguments are interpreted as reserved words. In addition to listing the words explicitly, you can use the <option>-f</option> option to specify a file which contains a whitespace-separated list of reserved words. If neither a word list nor an input file is specified, &appname;a attempts to read a whitespace-separated list of words from stdin. To force &appname;a to read from stdin <emphasis>in addition to</emphasis> explicitly listed words, use the <option>-f stdin</option> option.</para> <note> <para>&appname; will convert all reserved words to uppercase internally, so it does not matter in which case you provide these words.</para> @@ -472,5 +502,5 @@ <para>Use the <option>-o</option> and <option>-O</option> options to write or append the output to a file, respectively.</para> <warning> - <para>Be careful with the append (<option>-O</option>) option. &appname; will output the processing instructions, the doctype line, and one <sgmltag>CITESTYLE</sgmltag> element for each individually requested style. If you concatenate the results of several <command moreinfo="none">getstyle</command> calls, the resulting XML file will not be well-formed. In order to write several styles into a single XML file, use a single <command moreinfo="none">getstyle</command> call and list all required styles as arguments. This will output the styles wrapped in a <sgmltag>STYLESET</sgmltag> element, resulting in a valid XML file.</para> + <para>Be careful with the append (<option>-O</option>) option. &appname; will output the processing instructions, the doctype line, and one <sgmltag>CITESTYLE</sgmltag> element for each individually requested style. If you concatenate the results of several <command moreinfo="none">getstyle</command> calls, the resulting XML file will not be well-formed without further processing. In order to write several styles into a single XML file, use a single <command moreinfo="none">getstyle</command> call and list all required styles as arguments. This will output the styles wrapped in a <sgmltag>STYLESET</sgmltag> element, resulting in a valid XML file.</para> </warning> <para>All other arguments are interpreted as the names of bibliography styles.</para> Index: refdb-manual-chapter8.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter8.sgml,v retrieving revision 1.13.2.5 retrieving revision 1.13.2.6 diff -u -U2 -r1.13.2.5 -r1.13.2.6 --- refdb-manual-chapter8.sgml 14 Aug 2005 00:18:28 -0000 1.13.2.5 +++ refdb-manual-chapter8.sgml 14 Nov 2005 20:17:18 -0000 1.13.2.6 @@ -313,5 +313,5 @@ <itemizedlist> <listitem> - <para>When adding users with the <link linkend="app-a-command-adduser"><command moreinfo="none">adduser</command></link> command the <option>-H</option> option has to specify the box where &appname;d runs as the host, not the box from where the user will run the clients. If you do not specify a host, "localhost" is assumed.</para> + <para>When adding users with the <link linkend="app-a-command-adduser"><command moreinfo="none">adduser</command></link> command the <option>-H</option> option has to specify the box where &appname;d runs as the host, not the box from where the user will run the clients. If you do not specify a host, "localhost" is assumed. This works on some platforms (e.g. FreeBSD 5.4), but not on others (e.g. Fedora Core 4). In the latter case you may have to specify the hostname explicitly.</para> </listitem> <listitem> Index: refdb-manual-chapter9.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-chapter9.sgml,v retrieving revision 1.15.2.2 retrieving revision 1.15.2.3 diff -u -U2 -r1.15.2.2 -r1.15.2.3 --- refdb-manual-chapter9.sgml 14 Aug 2005 00:18:28 -0000 1.15.2.2 +++ refdb-manual-chapter9.sgml 14 Nov 2005 20:17:18 -0000 1.15.2.3 @@ -3,4 +3,8 @@ <title>Overview of the &appname; clients</title> <para>There are several client applications, each one performing a self-contained subset of tasks. This chapter provides a short overview over common features of the clients. Please refer to the reference chapters about <link linkend="chapter-refdba">&appname;a</link>, <link linkend="chapter-refdbc">&appname;c</link>, and <link linkend="chapter-refdbib">&appname;ib</link> for the nitty gritty details.</para> + <note> + <para>This manual covers only the clients shipped with &appname;. Please visit the <ulink url="http://refdb.sourceforge.net">&appname; website</ulink> for other options. Currently there is a PHP-based web interface and tools for both Emacs and Vim which turn these editors into integrated authoring tools with bibliography support.</para> + </note> + <para>The clients serve the following purposes:</para> <variablelist> <varlistentry> @@ -28,7 +32,4 @@ </keycombo> to search the history with a regular expression. For further information you should consult the readline manual.</para> <para>&appname;a and &appname;c can also be run in batch mode. You can specify one of the built-in commands as an argument to the <option>-C</option> option and pipe or redirect data into stdin. This is very useful if you want to automatize tasks using shell scripts.</para> - <note> - <para>Most platforms automatically detect that data are available at stdin. However, on some platforms (like Windows/Cygwin) you have to tell the client explicitly that you want to read data from stdin. To this end, use the <option>-f stdin</option> command line option. See also the individual descriptions of the commands that support reading from stdin for additional information.</para> - </note> <para>&appname;ib does not have an interactive mode and can be run only in batch mode. The result will be written to stdout. However, you'll hardly ever run &appname;ib directly, as &appname; ships with convenient scripts and Makefiles for this purpose.</para> <sect1> Index: refdb-manual-configopts.sgml =================================================================== RCS file: /cvsroot/refdb/refdb/doc/refdb-manual-configopts.sgml,v retrieving revision 1.4.2.5 retrieving revision 1.4.2.6 diff -u -U2 -r1.4.2.5 -r1.4.2.6 --- refdb-manual-configopts.sgml 21 Oct 2005 21:05:13 -0000 1.4.2.5 +++ refdb-manual-configopts.sgml 14 Nov 2005 20:17:18 -0000 1.4.2.6 @@ -63,5 +63,5 @@ <para>Specify the full path to the root directory of the TEI XSL stylesheets.</para> <note> - <para>The <ulink url="http://www.tei-c.org/Stylesheets/teixsl.html">TEI Consortium</ulink> ships two archives <filename moreinfo="none">P4/teixsl-fo.zip</filename> and <filename moreinfo="none">P4/teixsl-html.zip</filename>. The corresponding archives for the upcoming TEI P5 release are <filename moreinfo="none">P5/teixsl-fo.zip</filename> and <filename moreinfo="none">P5/teixsl-html.zip</filename>. &appname; expects the contents of these archives in two subdirectories <filename class="directory">P4</filename> and <filename class="directory">P5</filename> of the TEI XSL stylesheet root directory. If you e.g. use the TEI XSL stylesheet root directory <filename class="directory" moreinfo="none">/usr/local/share/xsl/tei</filename>, unpack <filename class="directory">P4/teixsl-fo.zip</filename> in <filename class="directory" moreinfo="none">/usr/local/share/xsl/tei/P4</filename>, and the expected subdirectories <filename class="directory">fo</filename>, <filename class="directory">html</filename>, and <filename class="directory">common</filename> will be created therein.</para> + <para>The <ulink url="http://www.tei-c.org">TEI Consortium</ulink> ships <ulink url="http://sourceforge.net/project/showfiles.php?group_id=106328&package_id=141124">tei-xsl-5.2.9.zip</ulink> which contains the stylesheets for both p4 and p5. The root directory which you want to specify here is the directory which contains the p4 and p5 subdirectories, e.g. <filename class="directory" moreinfo="none">/usr/local/share/xsl/tei-xsl-5.2.9</filename>.</para> </note> </listitem> |
