updated on Tue Jan 10 08:08:34 UTC 2012
[aur-mirror.git] / primer3 / primer3_core.1
blobfacbb9ce37c872c177b94a4c95ab45a91d395575
1 .\"     Title: PRIMER3_CORE
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4 .\"      Date: 02/22/2008
5 .\"    Manual: Primer3 User Manuals
6 .\"    Source: primer3_core 1.1.3
7 .\"
8 .TH "PRIMER3_CORE" "1" "02/22/2008" "primer3_core 1.1.3" "Primer3 User Manuals"
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 primer3_core - Designs primers for PCR
15 .SH "SYNOPSIS"
16 .HP 13
17 \fBprimer3_core\fR [\-format_output] [\-strict_tags] [<\ \fIinput_file\fR]
18 .SH "DESCRIPTION"
19 .PP
20 primer3_core picks primers for PCR reactions, considering as criteria oligonucleotide melting temperature, size, GC content and primer\-dimer possibilities, PCR product size, positional constraints within the source sequence, and miscellaneous other constraints\.
21 .PP
22 By default, primer3_core accepts input and produces output in Boulder\-io format, a pre\-XML text\-based input/output format for program\-to\-program data interchange format\. The Boulder\-io format and the commands that primer3_core understands are described in the
23 \fIREADME\fR
24 file, which on Debian systems can be found in
25 \fI/usr/share/doc/primer3/\fR\.
26 .SH "OPTIONS"
27 .PP
28 \fB\-format_output\fR
29 .RS 4
30 Prints a more user\-oriented report for each sequence\.
31 .RE
32 .PP
33 \fB\-strict_tags\fR
34 .RS 4
35 primer3_core echoes and ignores any tags it does not recognize, unless the
36 \fB\-strict_tags\fR
37 flag is set on the command line, in which case primer3_core prints an error in the PRIMER_ERROR output tag, and prints additional information on stdout; this option can be useful for debugging systems that incorporate primer\.
38 .RE
39 .sp
40 .it 1 an-trap
41 .nr an-no-space-flag 1
42 .nr an-break-flag 1
43 .br
44 Note
45 .PP
46 The old flag \-2x_compat is no longer supported\.
47 .SH "EXIT STATUS CODES"
48 .sp
49 .RS 4
50 \h'-04'\(bu\h'+03'0 on normal operation\.
51 .RE
52 .sp
53 .RS 4
54 \h'-04'\(bu\h'+03'\-1 under the following conditions: illegal command\-line arguments, unable to fflush stdout, unable to open (for writing and creating) a \.for, \.rev or \.int file (probably due to a protection problem)\.
55 .RE
56 .sp
57 .RS 4
58 \h'-04'\(bu\h'+03'\-2 on out\-of\-memory\.
59 .RE
60 .sp
61 .RS 4
62 \h'-04'\(bu\h'+03'\-3 empty input\.
63 .RE
64 .sp
65 .RS 4
66 \h'-04'\(bu\h'+03'\-4 error in a "Global" input tag (message in PRIMER_ERROR)\.
67 .RE
68 .SH "REFERENCE"
69 .PP
70 Please cite Rozen, S\., Skaletsky, H\. "Primer3 on the WWW for general users and for biologist programmers\." In S\. Krawetz and S\. Misener, eds\. Bioinformatics Methods and Protocols in the series Methods in Molecular Biology\. Humana Press, Totowa, NJ, 2000, pages 365\-386\.
71 .SH "SEE ALSO"
72 .PP
74 \fBntdpal\fR(1)
75 \fBoligotm\fR(1)
76 .SH "COPYRIGHT"
77 Copyright \(co 1996,1997,1998,1999,2000,2001,2004,2006,2007,2008 Whitehead Institute for Biomedical Research, Steve Rozen (http://jura.wi.mit.edu/rozen), Helen Skaletsky
78 .br
79 .PP
80 All rights reserved\. On Debian\-based systems, please consult
81 \fI/usr/share/doc/primer3/copyright\fR
82 to read the licence of primer3_core\.
83 .PP
84 This manual page was written by Steffen Moeller
85 <steffen_moeller@gmx\.de>
86 for the
87 Debian(TM)
88 system (but may be used by others)\. Permission is granted to copy, distribute and/or modify this document under the same terms as primer3_core itself\.
90 .sp