.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "GMOD_ADD_ORGANISM 1p" .TH GMOD_ADD_ORGANISM 1p "2018-09-27" "perl v5.26.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" $0 \- Adds an entry to the organism table .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& % gmod_add_organism.pl [options] .Ve .SH "COMMAND-LINE OPTIONS" .IX Header "COMMAND-LINE OPTIONS" .Vb 7 \& \-\-name_only Check just for a name, and return a 1 if present \& \-\-common_name \& \-\-genus \& \-\-species \& \-\-abbreviation \& \-\-comment \& \-\-dbprofile Specify a gmod.conf profile name (otherwise use default) .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This script will insert an entry into the Chado organism table. The combination genus and species is required to be unique. If either of those items are not provided, or if that combination is already in the database, the script will exit without doing anything. Technically, those are the only two things required, but it is strongly suggested that you provide a common_name and abbreviation. .PP The \-\-name_only option is intended for use primarily at install time, to check the database for the existence of an entry in the organism table with a given common_name. If it is present, it prints \*(L"1\*(R" and exits, otherwise it prints \*(L"0\*(R" and exits. The options \-\-common_name must be used in conjunction with \-\-name_only. .SH "AUTHOR" .IX Header "AUTHOR" Scott Cain .PP Copyright (c) 2011 .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.