Hi,
17.11.2008 11:46, Tilman Schmidt wrote:
> On Thu, 13 Nov 2008 08:46:38 -0800, Dan Langille wrote:
>> On Nov 13, 2008, at 1:55 AM, Tilman Schmidt wrote:
> [...]
>>> My suggestions for improvement (and no, I don't understand the Bacula
>>> source code nearly well enough to try and implement them myself)
>>> would be:
> [...]
>>> 4. Improve the manual by merging the "Alphabetical List of Console
>>> Keywords" and "Alphabetical List of Console Commands" section into a
>>> single list describing each command accepted by bconsole completely,
>>> with all keywords it will accept.
>> Item 4 can be done without knowing how to read code.
>
> What other approach do you propose for finding the information that
> is currently missing from the manual?
It would be easiest to track the -users list and simply write a
paragraph whenever you believe you can do so (actually, I'd like to do
that myself but simply don't find the time). It's not overly
complicated, I believe. Furthermore, a short, perhaps not perfect
description is often better than none at all - and it gives the
developers something to improve when they work on the manual anyway :-)
>> Anyone? Anyone?
>
> I could, provided the question above can be resolved.
> Where is the source for the manual and what is it written in?
You need some knowledge of svn and LaTeX.
Then, just use a text editor of your choice. Example text as it is
now, taken from svn/trunk/docs/manuals/en/console/bconsole.tex:
\label{restore_command}
\item [restore]
\index[general]{restore}
The restore command allows you to select one or more Jobs (JobIds)
to be
restored using various methods. Once the JobIds are selected, the
File
records for those Jobs are placed in an internal Bacula directory
tree,
and the restore enters a file selection mode that allows you to
interactively walk up and down the file tree selecting individual
files
to be restored. This mode is somewhat similar to the standard
Unix {\bf
restore} program's interactive file selection mode.
restore storage=\lt{}storage-name\gt{} client=\lt{}backup-client-name\gt{}
where=\lt{}path\gt{} pool=\lt{}pool-name\gt{}
fileset=\lt{}fileset-name\gt{}
restoreclient=\lt{}restore-client-name\gt{}
select current all done
Doesn't look very frightening, right?
After changing things, you create a diff like this:
svn diff Index: bconsole.tex
===================================================================
--- bconsole.tex (revision 7607)
+++ bconsole.tex (working copy)
@@ -911,9 +911,11 @@
\item [run]
\index[general]{run}
- This command allows you to schedule jobs to be run immediately.
The full form
- of the command is:
+ This command allows you to schedule jobs to be run immediately or at
+ a specified time in the future.
+ The full form of the command is:
+
run job=\lt{}job-name\gt{} client=\lt{}client-name\gt{}
fileset=\lt{}FileSet-name\gt{} level=\lt{}level-keyword\gt{}
storage=\lt{}storage-name\gt{} where=\lt{}directory-prefix\gt{}
and send the resulting output (preferrably captured in a file) to the
-docs mailing list.
If you really get into it, I'm sure Kern will grant you rights to
directly upload your changes to the repository.
Arno
> Thanks,
> Tilman
>
--
Arno Lehmann
IT-Service Lehmann
Sandstr. 6, 49080 Osnabrück
www.its-lehmann.de
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Bacula-users mailing list
Bacula-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/bacula-users
