[svn-inject] Installing original source of jabref
[debian/jabref.git] / src / help / CommandLine.html
1 <HTML>
2
3 <BODY text="#275856">
4 <basefont size="4" color="#2F4958" face="arial">
5
6 <H1>Command line options</H1>
7
8 Although JabRef is primarily a GUI based application, it offers several command line options
9 that may be useful, and can even perform file conversion operations without opening the graphical
10 interface.
11
12 <P>You can always specify one or more BibTeX files to load by simply listing their filenames. Take care to
13   specify all options before your list of file names. You must make sure the first file name is not misunderstood
14   as being an argument for an option - this simply means that if a boolean option like <code>-n</code> or
15 <code>-l</code> immediately precedes a file name, add the word "true" as an argument. For instance, the command
16 line:
17 <p><code>jabref -o filetoexport.xml,docbook -n true original.bib</code>
18 <p>will correctly load the file <code>original.bib</code>, export it in docbook format to <code>filetoexport.xml</code>,
19   and suppress the GUI. The word <em>true</em> prevents the file name from being interpreted as an argument to the
20   -n option.
21
22 <H2>Help: -h</H2>
23
24 This option causes JabRef to display a summary of the command line options, and quit immediately.
25
26 <H2>No-GUI mode: -n</H2>
27
28 This option suppresses both the JabRef window and the splash window normally shown at startup. It
29 causes the program to quit immediately once the command line options have been processed.
30 <P>This option is useful for performing file conversion operations from the command line or a script.
31
32 <H2>Load session: -l</H2>
33
34 This option causes JabRef to load the saved session, if any, before opening the main window.
35
36 <H2>Import file: -i filename[,format]</H2>
37
38 This option causes JabRef to import or load the specified file. If only a filename is specified, or
39 the filename is followed by a comma and a * character, JabRef will attempt to detect the file format
40 automatically. This should work for all BibTeX files and files in any import format supported by JabRef.
41 If the filename is followed by a comma and the name of an import format, the given import
42 filter will be used. Use the <code>-h</code> option to get a list of availiable import formats.
43
44 <P>If an output option is also specified, an import will always be processed before it, and the imported or
45   loaded file will be given to the export filter. If the GUI is not suppressed using the <code>-n</code> option,
46   any imported or loaded file will show up in the main window.
47 <p>The -i option can be specified only once, and for one file only.
48
49 <H2>Export file: -o filename[,format]</H2>
50
51 This option causes JabRef to save or export a file imported or loaded by the same command line. If a file is
52 imported using the <code>-i</code> option, that database will be exported. Otherwise, the <em>last</em> file
53 specified (and successfully loaded) without the <code>-i</code> option will be exported.
54
55 <P>If only a filename
56 is specified, it will be saved in BibTeX format. If the filename is followed by a comma and an export format,
57 the given export filter will be used. A custom export filter can be used in this way, and will be preferred if
58 the export name matches both a custom and a standard export filter.
59 <P>Use the <code>-h</code> option to get a list of availiable export formats.
60
61 <P>If the <code>-n</code> option has not been invoked, any export operation will be performed before the JabRef
62   window is opened, and the imported database will show up in the window.
63
64 <p>The -o option can be specified only once, and for one file only.
65
66 <H2>Export preferences: -x filename</H2>
67
68 Using this option, you can have JabRef export all user preferences to an XML file. After exporting,
69 JabRef will start normally.
70
71 <H2>Import preferences: -p filename</H2>
72
73 This option causes JabRef to import user preferences exported using the <code>-x</code>
74 option. After importing, JabRef will start normally.
75
76 <H2>Export only used items: -a filename[.aux],newBibFile[.bib]</H2>
77
78 Sometimes it is helpful, to have a bibtex file that contains only the used bibtex entries.
79 A list of these used entries is located in an aux file. Jabref can parse this file to
80 generate a new bibtex file, which contains only the known and used entries. That will mean, 
81 if an entry is not defined in the standard bibtex file, it cannot be located in the new 
82 file.
83
84 </BODY>
85 </HTML>