Update jabref(1) manpage which was out of sync with the -h output.
[debian/jabref.git] / debian / jabref.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH JABREF 1 "January 23, 2014"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 jabref \- graphical frontend to manage BibTeX databases
20 .SH SYNOPSIS
21 .B jabref [options] [bibtex\-file]
22 .SH DESCRIPTION
23 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
24 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
25 .\" respectively.
26 \fBJabRef\fP is a graphical Java application for editing bibtex (.bib)
27 databases. JabRef lets you organize your entries into overlapping
28 logical groups, and with a single click limit your view to a single
29 group or an intersection or union of several groups. You can customize
30 the entry information shown in the main window, and sort by any of the
31 standard Bibtex fields. JabRef can autogenerate bibtex keys for your
32 entries. JabRef also lets you easily link to PDF or web sources for your
33 reference entries.
34 .br
35 JabRef can import from and export to several formats, and you can
36 customize export filters. JabRef can be run as a command line application
37 to convert from any import format to any export format.
38 .SH OPTIONS
39 .TP
40 \fB\-a\fR, \fB\-\-aux\fR=<STRING>
41 Subdatabase from aux: file[.aux],new[.bib]
42 .TP
43 \fB\-b\fR, \fB\-\-blank\fR=<BOOLEAN>
44 Do not open any files at startup
45 .TP
46 \fB\-d\fR, \fB\-\-prdef\fR=<STRING>
47 Reset preferences (key1,key2,... or 'all')
48 .TP
49 \fB\-f\fR, \fB\-\-fetch\fR=<STRING>
50 Run Fetcher, e.g. "\-\-fetch=Medline:cancer"
51 .TP
52 \fB\-h\fR, \fB\-\-help\fR=<BOOLEAN>
53 Display help on command line options and a list of available import/export formats
54 .TP
55 \fB\-i\fR, \fB\-\-import\fR=<STRING>
56 Import file: filename[,import format]
57 .TP
58 \fB\-\-importToOpen\fR=<STRING>
59 Import to open tab
60 .TP
61 \fB\-l\fR, \fB\-\-loads\fR=<BOOLEAN>
62 Load session
63 .TP
64 \fB\-m\fR, \fB\-\-exportMatches\fR=<STRING>
65 [field=]searchTerm,outputfile[,exportFormat]
66 .TP
67 \fB\-n\fR, \fB\-\-nogui\fR=<BOOLEAN>
68 No GUI. Only process command line options.
69 .TP
70 \fB\-o\fR, \fB\-\-output\fR=<STRING>
71 Output or export file: filename[,export format]
72 .TP
73 \fB\-p\fR, \fB\-\-primp\fR=<STRING>
74 Import preferences from file
75 .TP
76 \fB\-s\fR, \fB\-\-nosplash\fR=<BOOLEAN>
77 Do not show splash window at startup
78 .TP
79 \fB\-v\fR, \fB\-\-version\fR=<BOOLEAN>
80 Display version
81 .TP
82 \fB\-x\fR, \fB\-\-prexp\fR=<STRING>
83 Export preferences to file
84 .SH EXAMPLES
85 Export a selection of references:
86 .TP
87 \fBjabref \-m '(author=bock or title|keywords="computer methods") and not
88 (author=sager)',output.html,html \-n true inputfile.bib\fB
89 .TP
90 For information referring to the search function see the documentation for 'advanced search'.
91 Custom export formats can be added within the program
92 (options - manage custom exports). Available export formats are listed by
93 the help (jabref \-h).
94 .SH JAVA-WRAPPERS NOTE
95 This program is a shell script wrapper based on
96 .BR java-wrappers (7).
97 You therefore benefit from several features; please see the
98 .BR java-wrappers (7)
99 manual page for more information about them.
100 .SH SEE ALSO
101 the included help and commandline help: jabref \-h
102 .br
103 http://jabref.sourceforge.net/
104 .br
105 .BR java-wrappers (7)
106 .SH AUTHOR
107 jabref was written by Morten O. Alver and Nizar Batada.
108 .PP
109 This manual page was written by gregor herrmann <gregoa@debian.org>,
110 for the Debian project (but may be used by others).
111 .SH CONTRIBUTORS
112 Thanks to Martin Weis <martin.weis.newsadress@gmx.de> for his updates to this manual page.