[svn-upgrade] Integrating new upstream version, jabref (2.5~beta1)
[debian/jabref.git] / src / help / CommandLine.html
1 <html xmlns="http://www.w3.org/1999/xhtml">
2
3 <body text="#275856">
4     <basefont size="4" color="#2F4958" face="arial" />
5
6     <h1>Command line options</h1>
7
8     <p>Although JabRef is primarily a GUI
9     based application, it offers several command line options that
10     may be useful, and can even perform file conversion operations
11     without opening the graphical interface.</p>
12
13     <p>You can always specify one or more BibTeX files to load by
14     simply listing their filenames. Take care to specify all
15     options before your list of file names. You must make sure the
16     first file name is not misunderstood as being an argument for
17     an option - this simply means that if a boolean option like
18     <code>-n</code> or <code>-l</code> immediately precedes a file
19     name, add the word "true" as an argument. For instance, the
20     command line:</p>
21
22     <p><code>jabref -o filetoexport.xml,docbook -n true
23     original.bib</code></p>
24
25     <p>will correctly load the file <code>original.bib</code>,
26     export it in docbook format to <code>filetoexport.xml</code>,
27     and suppress the GUI. The word <em>true</em> prevents the file
28     name from being interpreted as an argument to the -n
29     option.</p>
30
31     <h2>Help: -h</h2>
32
33     <p>This option causes JabRef to display a summary
34     of the command line options, and quit immediately.</p>
35
36     <h2>No-GUI mode: -n</h2>
37
38     <p>This option suppresses both the JabRef
39     window and the splash window normally shown at startup. It
40     causes the program to quit immediately once the command line
41     options have been processed.</p>
42
43     <p>This option is useful for performing file conversion
44     operations from the command line or a script.</p>
45
46     <h2>Load session: -l</h2>
47
48     <p>This option causes JabRef to load the
49     saved session, if any, before opening the main window.</p>
50
51     <h2>Import file: -i filename[,format]</h2>
52
53     <p>This option causes
54     JabRef to import or load the specified file. If only a filename
55     is specified, or the filename is followed by a comma and a *
56     character, JabRef will attempt to detect the file format
57     automatically. This should work for all BibTeX files and files
58     in any import format supported by JabRef. If the filename is
59     followed by a comma and the name of an import format, the given
60     import filter will be used. Use the <code>-h</code> option to
61     get a list of availiable import formats.</p>
62
63     <p>If an output option is also specified, an import will always
64     be processed before it, and the imported or loaded file will be
65     given to the export filter. If the GUI is not suppressed using
66     the <code>-n</code> option, any imported or loaded file will
67     show up in the main window.</p>
68
69     <p>The -i option can be specified only once, and for one file
70     only.</p>
71
72     <h2>Export file: -o filename[,format]</h2>
73
74     <p>This option causes
75     JabRef to save or export a file imported or loaded by the same
76     command line. If a file is imported using the <code>-i</code>
77     option, that database will be exported. Otherwise, the
78     <em>last</em> file specified (and successfully loaded) without
79     the <code>-i</code> option will be exported.</p>
80
81     <p>If only a filename is specified, it will be saved in BibTeX
82     format. If the filename is followed by a comma and an export
83     format, the given export filter will be used. A custom export
84     filter can be used in this way, and will be preferred if the
85     export name matches both a custom and a standard export
86     filter.</p>
87
88     <p>Use the <code>-h</code> option to get a list of availiable
89     export formats.</p>
90
91     <p>If the <code>-n</code> option has not been invoked, any
92     export operation will be performed before the JabRef window is
93     opened, and the imported database will show up in the
94     window.</p>
95
96     <p>The -o option can be specified only once, and for one file
97     only.</p>
98
99     <h2>Export preferences: -x filename</h2>
100
101     <p>Using this option, you
102     can have JabRef export all user preferences to an XML file.
103     After exporting, JabRef will start normally.</p>
104
105     <h2>Import preferences: -p filename</h2>
106
107     <p>This option causes
108     JabRef to import user preferences exported using the
109     <code>-x</code> option. After importing, JabRef will start
110     normally.</p>
111
112     <h2>Export only used items: -a
113     filename[.aux],newBibFile[.bib]</h2>
114
115     <p>Sometimes it is helpful, to
116     have a bibtex file that contains only the used bibtex entries.
117     A list of these used entries is located in an aux file. Jabref
118     can parse this file to generate a new bibtex file, which
119     contains only the known and used entries. That will mean, if an
120     entry is not defined in the standard bibtex file, it cannot be
121     located in the new file.</p>
122     
123     <h2>Fetch from Web: --fetch==name of fetcher:query string</h2>
124     
125     <p>The fetchers in the Web menu can also be run from the command 
126     line. Use the --fetch option and then pass both the name of a fetcher 
127     (for instance ieee, medline or jstor) and your search term or paper id and 
128     the given fetcher will be run. Note that some fetcher will still display 
129     GUI if they need feedback from you. To get a list of available fetchers run
130     --fetch without parameters.</p>
131 </body>
132 </html>