releasing package jabref version 2.10~beta2+ds-2
[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 "September 12, 2009"
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\-o\fR, \fB\-\-output\fR=<STRING>
41 Output or export file: filename[,export format]
42 .TP
43 \fB\-p\fR, \fB\-\-primp\fR=<STRING>
44 Import preferences from file
45 .TP
46 \fB\-f\fR, \fB\-\-fetch\fR=<STRING>
47 Run Fetcher, e.g. "\-\-fetch=Medline:cancer"
48 .TP
49 \fB\-n\fR, \fB\-\-nogui\fR=<BOOLEAN>
50 No GUI. Only process command line options.
51 .TP
52 \fB\-a\fR, \fB\-\-aux\fR=<STRING>
53 Subdatabase from aux: file[.aux],new[.bib]
54 .TP
55 \fB\-h\fR, \fB\-\-help\fR=<BOOLEAN>
56 Display help on command line options
57 .TP
58 \fB\-b\fR, \fB\-\-blank\fR=<BOOLEAN>
59 Do not open any files at startup
60 .TP
61 \fB\-\-importToOpen\fR=<STRING>
62 Import to open tab
63 .TP
64 \fB\-i\fR, \fB\-\-import\fR=<STRING>
65 Import file: filename[,import format]
66 .TP
67 \fB\-s\fR, \fB\-\-nosplash\fR=<BOOLEAN>
68 Do not show splash window at startup
69 .TP
70 \fB\-x\fR, \fB\-\-prexp\fR=<STRING>
71 Export preferences to file
72 .TP
73 \fB\-v\fR, \fB\-\-version\fR=<BOOLEAN>
74 Display version
75 .TP
76 \fB\-l\fR, \fB\-\-loads\fR=<BOOLEAN>
77 Load session
78 .SH JAVA-WRAPPERS NOTE
79 This program is a shell script wrapper based on
80 .BR java-wrappers (7).
81 You therefore benefit from several features; please see the 
82 .BR java-wrappers (7)
83 manual page for more information about them.
84 .SH SEE ALSO
85 the included help
86 .br
87 http://jabref.sourceforge.net/
88 .br
89 .BR java-wrappers (7)
90 .SH AUTHOR
91 jabref was written by Morten O. Alver and Nizar Batada.
92 .PP
93 This manual page was written by gregor herrmann <gregor+debian@comodo.priv.at>,
94 for the Debian project (but may be used by others).