Imported Upstream version 2.11~beta1+ds
[debian/jabref.git] / src / main / resources / help / CommandLine.html
1 <html xmlns="http://www.w3.org/1999/xhtml">
2 <head>
3 <link rel="stylesheet" type="text/css" href="jabref_help.css"/>
4 </head>
5
6 <body>
7
8     <h1>Command line options</h1>
9
10     <p>Although JabRef is primarily a GUI
11     based application, it offers several command line options that
12     may be useful, and can even perform file conversion operations
13     without opening the graphical interface.</p>
14
15     <p>You can always specify one or more BibTeX files to load by
16     simply listing their filenames. Take care to specify all
17     options before your list of file names. You must make sure the
18     first file name is not misunderstood as being an argument for
19     an option - this simply means that if a boolean option like
20     <code>-n</code> or <code>-l</code> immediately precedes a file
21     name, add the word "true" as an argument. For instance, the
22     command line:</p>
23
24     <p><code>jabref -o filetoexport.xml,docbook -n true
25     original.bib</code></p>
26
27     <p>will correctly load the file <code>original.bib</code>,
28     export it in docbook format to <code>filetoexport.xml</code>,
29     and suppress the GUI. The word <em>true</em> prevents the file
30     name from being interpreted as an argument to the -n
31     option.</p>
32
33     <h2>Help: -h</h2>
34
35     <p>This option causes JabRef to display a summary
36     of the command line options, and quit immediately.</p>
37
38     <h2>No-GUI mode: -n</h2>
39
40     <p>This option suppresses both the JabRef
41     window and the splash window normally shown at startup. It
42     causes the program to quit immediately once the command line
43     options have been processed.</p>
44
45     <p>This option is useful for performing file conversion
46     operations from the command line or a script.</p>
47
48     <h2>Load session: -l</h2>
49
50     <p>This option causes JabRef to load the
51     saved session, if any, before opening the main window.</p>
52
53     <h2>Import file: -i filename[,format]</h2>
54
55     <p>This option causes
56     JabRef to import or load the specified file. If only a filename
57     is specified, or the filename is followed by a comma and a *
58     character, JabRef will attempt to detect the file format
59     automatically. This should work for all BibTeX files and files
60     in any import format supported by JabRef. If the filename is
61     followed by a comma and the name of an import format, the given
62     import filter will be used. Use the <code>-h</code> option to
63     get a list of availiable import formats.</p>
64
65     <p>If an output option is also specified, an import will always
66     be processed before it, and the imported or loaded file will be
67     given to the export filter. If the GUI is not suppressed using
68     the <code>-n</code> option, any imported or loaded file will
69     show up in the main window.</p>
70
71     <p>The -i option can be specified only once, and for one file
72     only.</p>
73
74     <h2>Export file: -o filename[,format]</h2>
75
76     <p>This option causes
77     JabRef to save or export a file imported or loaded by the same
78     command line. If a file is imported using the <code>-i</code>
79     option, that database will be exported. Otherwise, the
80     <em>last</em> file specified (and successfully loaded) without
81     the <code>-i</code> option will be exported.</p>
82
83     <p>If only a filename is specified, it will be saved in BibTeX
84     format. If the filename is followed by a comma and an export
85     format, the given export filter will be used. A custom export
86     filter can be used in this way, and will be preferred if the
87     export name matches both a custom and a standard export
88     filter.</p>
89
90     <p>Use the <code>-h</code> option to get a list of availiable
91     export formats.</p>
92
93     <p>If the <code>-n</code> option has not been invoked, any
94     export operation will be performed before the JabRef window is
95     opened, and the imported database will show up in the
96     window.</p>
97
98     <p>The -o option can be specified only once, and for one file
99     only.</p>
100
101     <h2>Export preferences: -x filename</h2>
102
103     <p>Using this option, you
104     can have JabRef export all user preferences to an XML file.
105     After exporting, JabRef will start normally.</p>
106
107     <h2>Import preferences: -p filename</h2>
108
109     <p>This option causes
110     JabRef to import user preferences exported using the
111     <code>-x</code> option. After importing, JabRef will start
112     normally.</p>
113     
114     <h2>Export matching entries: -m [field=]searchTerm,outputFile[,exportFormat]</h2>
115     <p>JabRef saves all the database entries matching to a given search term in a new file.
116     The export file's format can be chosen, the default format is html-table (with abstract
117     and bibtex, provided by tablerefsabsbib).
118     </p>
119     <p>Call: <code>JabRef.jar -m [field=]searchTerm,outputFile[,exportFormat] -n true inputFile</code></p>
120     <p>For information referring to the search function see the documentation for 'advanced search'.
121     In addition it is also possible to search for entries within a timeframe instead of only
122     searching for entries of a certain year.</p>
123     <p>Please note that search terms containing blanks need to be bracketed by quotation marks.</p>
124         <p>Examples</p>
125         <ul>
126                 <li> <code>Year=2005</code> </li>
127                 <li> <code>title|keywords=Optimization</code> </li>
128                 <li> <code>(author=bock or title|keywords="computer methods")and not(author=sager)</code> </li>
129                 <li> <code>Year=1989-2005</code> </li>
130         </ul>
131
132     <h2>Export only used items: -a
133     filename[.aux],newBibFile[.bib]</h2>
134
135     <p>Sometimes it is helpful, to
136     have a bibtex file that contains only the used bibtex entries.
137     A list of these used entries is located in an aux file. Jabref
138     can parse this file to generate a new bibtex file, which
139     contains only the known and used entries. That will mean, if an
140     entry is not defined in the standard bibtex file, it cannot be
141     located in the new file.</p>
142     
143     <h2>Fetch from Web: --fetch==name of fetcher:query string</h2>
144     
145     <p>The fetchers in the Web menu can also be run from the command 
146     line. Use the --fetch option and then pass both the name of a fetcher 
147     (for instance ieee, medline or jstor) and your search term or paper id and 
148     the given fetcher will be run. Note that some fetcher will still display 
149     GUI if they need feedback from you. To get a list of available fetchers run
150     --fetch without parameters.</p>
151 </body>
152 </html>