update branches/2.5 from beta1 to the 2.5 release
[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 "March 16, 2008"
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 frontend to manage BibTeX databases, the
27 standard LaTeX bibliography reference format. JabRef is build to be
28 platform independent (requires Java 1.5 or newer). It merges and extends
29 the functionalities of BibKeeper (Morten O. Alver) and JBibtexManager
30 (Nizar Batada)
31 .SH OPTIONS
32 .TP
33 \fB\-o\fR, \fB\-\-output\fR=<STRING>
34 Output or export file: filename[,export format]
35 .TP
36 \fB\-p\fR, \fB\-\-primp\fR=<STRING>
37 Import preferences from file
38 .TP
39 \fB\-f\fR, \fB\-\-fetch\fR=<STRING>
40 Run Fetcher, e.g. "\-\-fetch=Medline:cancer"
41 .TP
42 \fB\-n\fR, \fB\-\-nogui\fR=<BOOLEAN>
43 No GUI. Only process command line options.
44 .TP
45 \fB\-a\fR, \fB\-\-aux\fR=<STRING>
46 Subdatabase from aux: file[.aux],new[.bib]
47 .TP
48 \fB\-h\fR, \fB\-\-help\fR=<BOOLEAN>
49 Display help on command line options
50 .TP
51 \fB\-b\fR, \fB\-\-blank\fR=<BOOLEAN>
52 Do not open any files at startup
53 .TP
54 \fB\-\-importToOpen\fR=<STRING>
55 Import to open tab
56 .TP
57 \fB\-i\fR, \fB\-\-import\fR=<STRING>
58 Import file: filename[,import format]
59 .TP
60 \fB\-s\fR, \fB\-\-nosplash\fR=<BOOLEAN>
61 Do not show splash window at startup
62 .TP
63 \fB\-x\fR, \fB\-\-prexp\fR=<STRING>
64 Export preferences to file
65 .TP
66 \fB\-v\fR, \fB\-\-version\fR=<BOOLEAN>
67 Display version
68 .TP
69 \fB\-l\fR, \fB\-\-loads\fR=<BOOLEAN>
70 Load session
71 .SH JAVA-WRAPPERS NOTE
72 This program is a shell script wrapper based on
73 .BR java-wrappers (7).
74 You therefore benefit from several features; please see the 
75 .BR java-wrappers (7)
76 manual page for more information about them.
77 .SH SEE ALSO
78 the included help
79 .br
80 http://jabref.sourceforge.net/
81 .br
82 .BR java-wrappers (7)
83 .SH AUTHOR
84 jabref was written by Morten O. Alver and Nizar Batada.
85 .PP
86 This manual page was written by gregor herrmann <gregor+debian@comodo.priv.at>,
87 for the Debian project (but may be used by others).