[Rt-commit] r13060 - rt/branches/3.8-TESTING/etc
sunnavy at bestpractical.com
sunnavy at bestpractical.com
Mon Jun 9 13:34:01 EDT 2008
Author: sunnavy
Date: Mon Jun 9 13:34:00 2008
New Revision: 13060
Modified:
rt/branches/3.8-TESTING/etc/RT_Config.pm.in
Log:
go on improving pod
Modified: rt/branches/3.8-TESTING/etc/RT_Config.pm.in
==============================================================================
--- rt/branches/3.8-TESTING/etc/RT_Config.pm.in (original)
+++ rt/branches/3.8-TESTING/etc/RT_Config.pm.in Mon Jun 9 13:34:00 2008
@@ -1,7 +1,3 @@
-#
-# WARNING: NEVER EDIT RT_Config.pm. Instead, copy any sections you want to change to RT_SiteConfig.pm
-# and edit them there.
-#
package RT;
@@ -15,6 +11,14 @@
=cut
+=head1 WARNING
+
+NEVER EDIT RT_Config.pm.
+
+Instead, copy any sections you want to change to F<RT_SiteConfig.pm> and edit them there.
+
+=cut
+
=head1 Base Configuration
=over 4
@@ -22,7 +26,7 @@
=item C<$rtname>
C<$rtname> is the string that RT will look for in mail messages to
-figure out what ticket a new piece of mail belongs to
+figure out what ticket a new piece of mail belongs to.
Your domain name is recommended, so as not to pollute the namespace.
once you start using a given tag, you should probably never change it.
@@ -36,18 +40,18 @@
=item C<$EmailSubjectTagRegex>
This regexp controls what subject tags RT recognizes as its own.
-If you're not dealing with historical $rtname values, you'll likely
+If you're not dealing with historical C<$rtname> values, you'll likely
never have to enable this feature.
-Be VERY CAREFUL with it. Note that it overrides $rtname for subject
+Be VERY CAREFUL with it. Note that it overrides C<$rtname> for subject
token matching and that you should use only "non-capturing" parenthesis
grouping. For example:
- Set($EmailSubjectTagRegex, qr/(?:example.com|example.org)/i );
+C<Set($EmailSubjectTagRegex, qr/(?:example.com|example.org)/i );>
and NOT
- Set($EmailSubjectTagRegex, qr/(example.com|example.org)/i );
+C<Set($EmailSubjectTagRegex, qr/(example.com|example.org)/i );>
This setting would make RT behave exactly as it does without the
setting enabled.
@@ -61,7 +65,7 @@
=item C<$Organization>
You should set this to your organization's DNS domain. For example,
-fsck.com or asylum.arkham.ma.us. It's used by the linking interface to
+I<fsck.com> or I<asylum.arkham.ma.us>. It's used by the linking interface to
guarantee that ticket URIs are unique and easy to construct.
=cut
@@ -70,8 +74,8 @@
=item C<$MinimumPasswordLength>
-$MinimumPasswordLength defines the minimum length for user
-passwords. Setting it to 0 disables this check
+C<$MinimumPasswordLength> defines the minimum length for user
+passwords. Setting it to 0 disables this check.
=cut
@@ -79,7 +83,7 @@
=item C<$Timezone>
-$Timezone is used to convert times entered by users into GMT and back again
+C<$Timezone> is used to convert times entered by users into GMT and back again
It should be set to a timezone recognized by your local unix box.
=cut
@@ -94,7 +98,9 @@
=item C<$DatabaseType>
-Database driver being used; case matters. Valid types are "mysql", "Oracle" and "Pg"
+Database driver being used; case matters.
+
+Valid types are "mysql", "Oracle" and "Pg"
=cut
@@ -102,7 +108,8 @@
=item C<$DatabaseHost>, C<$DatabaseRTHost>
-The domain name of your database server
+The domain name of your database server.
+
If you're running mysql and it's on localhost,
leave it blank for enhanced performance
@@ -130,7 +137,7 @@
=item C<$DatabasePassword>
-Password the DatabaseUser should use to access the database
+Password the C<$DatabaseUser> should use to access the database
=cut
@@ -147,7 +154,7 @@
=item C<$DatabaseRequireSSL>
If you're using Postgres and have compiled in SSL support,
-set DatabaseRequireSSL to 1 to turn on SSL communication
+set C<$DatabaseRequireSSL> to 1 to turn on SSL communication
=cut
@@ -155,13 +162,13 @@
=back
-=head1 Incoming mail gateway configuration
+=head1 Incoming Mail Gateway Configuration
=over 4
=item C<$OwnerEmail>
-OwnerEmail is the address of a human who manages RT. RT will send
+C<$OwnerEmail> is the address of a human who manages RT. RT will send
errors generated by the mail gateway to this address. This address
should _not_ be an address that's managed by your RT instance.
@@ -171,8 +178,8 @@
=item C<$LoopsToRTOwner>
-If $LoopsToRTOwner is defined, RT will send mail that it believes
-might be a loop to $OwnerEmail
+If C<$LoopsToRTOwner> is defined, RT will send mail that it believes
+might be a loop to C<$OwnerEmail>
=cut
@@ -180,8 +187,9 @@
=item C<$StoreLoops>
-If $StoreLoops is defined, RT will record messages that it believes
+If C<$StoreLoops> is defined, RT will record messages that it believes
to be part of mail loops.
+
As it does this, it will try to be careful not to send mail to the
sender of these messages
@@ -191,7 +199,7 @@
=item C<$MaxAttachmentSize>
-$MaxAttachmentSize sets the maximum size (in bytes) of attachments stored
+C<$MaxAttachmentSize> sets the maximum size (in bytes) of attachments stored
in the database.
For mysql and oracle, we set this size at 10 megabytes.
@@ -205,8 +213,8 @@
=item C<$TruncateLongAttachments>
-$TruncateLongAttachments: if this is set to a non-undef value,
-RT will truncate attachments longer than MaxAttachmentSize.
+C<$TruncateLongAttachments>: if this is set to a non-undef value,
+RT will truncate attachments longer than C<$MaxAttachmentSize>.
=cut
@@ -214,8 +222,8 @@
=item C<$DropLongAttachments>
-$DropLongAttachments: if this is set to a non-undef value,
-RT will silently drop attachments longer than MaxAttachmentSize.
+C<$DropLongAttachments>: if this is set to a non-undef value,
+RT will silently drop attachments longer than C<MaxAttachmentSize>.
=cut
@@ -223,11 +231,11 @@
=item C<$ParsenewMessageForTicketCcs>
-If $ParseNewMessageForTicketCcs is true, RT will attempt to divine
+If C<$ParseNewMessageForTicketCcs> is true, RT will attempt to divine
Ticket 'Cc' watchers from the To and Cc lines of incoming messages
Be forewarned that if you have _any_ addresses which forward mail to
RT automatically and you enable this option without modifying
-"RTAddressRegexp" below, you will get yourself into a heap of trouble.
+C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
=cut
@@ -235,7 +243,7 @@
=item C<$RTAddressRegexp>
-$RTAddressRegexp is used to make sure RT doesn't add itself as a ticket CC if
+C<$RTAddressRegexp> is used to make sure RT doesn't add itself as a ticket CC if
the setting above is enabled.
=cut
@@ -246,10 +254,13 @@
RT provides functionality which allows the system to rewrite
incoming email addresses. In its simplest form,
-you can substitute the value in CanonicalizeEmailAddressReplace
-for the value in CanonicalizeEmailAddressMatch
-(These values are passed to the CanonicalizeEmailAddress subroutine in RT/User.pm)
-By default, that routine performs a s/$Match/$Replace/gi on any address passed to it
+you can substitute the value in $<CanonicalizeEmailAddressReplace>
+for the value in $<CanonicalizeEmailAddressMatch>
+(These values are passed to the $<CanonicalizeEmailAddress> subroutine in
+ F<RT/User.pm>)
+
+By default, that routine performs a C<s/$Match/$Replace/gi> on any address
+passed to it.
=cut
@@ -258,8 +269,9 @@
=item C<$CanonicalizeEmailAddressMatch>
-set this to true and the create new user page will use the values that you
-enter in the form but use the function CanonicalizeUserInfo in User_Local.pm
+Set this to true and the create new user page will use the values that you
+enter in the form but use the function CanonicalizeUserInfo in
+F<RT/User_Local.pm>
=cut
@@ -267,13 +279,13 @@
=item C<$SenderMustExistInExternalDatabase>
-If $SenderMustExistInExternalDatabase is true, RT will refuse to
+If C<$SenderMustExistInExternalDatabase> is true, RT will refuse to
create non-privileged accounts for unknown users if you are using
-the "LookupSenderInExternalDatabase" option.
+the C<$LookupSenderInExternalDatabase> option.
Instead, an error message will be mailed and RT will forward the
-message to $RTOwner.
+message to C<$RTOwner>.
-If you are not using $LookupSenderInExternalDatabase, this option
+If you are not using C<$LookupSenderInExternalDatabase>, this option
has no effect.
If you define an AutoRejectRequest template, RT will use this
@@ -285,14 +297,14 @@
=item C<@MailPlugins>
- at MailPlugins is a list of auth plugins for L<RT::Interface::Email>
+C<@MailPlugins> is a list of auth plugins for L<RT::Interface::Email>
to use; see L<rt-mailgate>
=cut
=item C<$UnsafeEmailCommands>
-$UnsafeEmailCommands, if set to true, enables 'take' and 'resolve'
+C<$UnsafeEmailCommands>, if set to true, enables 'take' and 'resolve'
as possible actions via the mail gateway. As its name implies, this
is very unsafe, as it allows email with a forged sender to possibly
resolve arbitrary tickets!
@@ -314,18 +326,18 @@
=back
-=head1 Outgoing mail configuration
+=head1 Outgoing Mail Configuration
=over 4
=item C<$MailCommand>
-$MailCommand defines which method RT will use to try to send mail.
+C<$MailCommand> defines which method RT will use to try to send mail.
We know that 'sendmailpipe' works fairly well. If 'sendmailpipe'
doesn't work well for you, try 'sendmail'. Other options are 'smtp'
or 'qmail'.
-Note that you should remove the '-t' from $SendmailArguments
+Note that you should remove the '-t' from C<$SendmailArguments>
if you use 'sendmail' rather than 'sendmailpipe'
=cut
@@ -336,19 +348,19 @@
=head1 Sendmail Configuration
-These options only take effect if $MailCommand is 'sendmail' or
+These options only take effect if C<$MailCommand> is 'sendmail' or
'sendmailpipe'
=over 4
=item C<$SendmailArguments>
-$SendmailArguments defines what flags to pass to $SendmailPath
-If you picked 'sendmailpipe', you MUST add a -t flag to $SendmailArguments
+C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
+If you picked 'sendmailpipe', you MUST add a -t flag to C<$SendmailArguments>
These options are good for most sendmail wrappers and workalikes
These arguments are good for sendmail brand sendmail 8 and newer
-Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");
+C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
=cut
@@ -357,7 +369,7 @@
=item C<$SendmailBounceArguments>
-$SendmailBounceArguments defines what flags to pass to $Sendmail
+C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
assuming RT needs to send an error (ie. bounce).
=cut
@@ -367,7 +379,7 @@
=item C<$SendmailPath>
If you selected 'sendmailpipe' above, you MUST specify the path to
-your sendmail binary in $SendmailPath.
+your sendmail binary in C<$SendmailPath>.
=cut
@@ -376,15 +388,15 @@
=back
-=head1 SMTP configuration
+=head1 SMTP Configuration
-These options only take effect if $MailCommand is 'smtp'
+These options only take effect if C<$MailCommand> is 'smtp'
=over 4
=item C<$SMTPServer>
-$SMTPServer should be set to the hostname of the SMTP server to use
+C<$SMTPServer> should be set to the hostname of the SMTP server to use
=cut
@@ -392,7 +404,7 @@
=item C<$SMTPFrom>
-$SMTPFrom should be set to the 'From' address to use, if not the
+C<$SMTPFrom> should be set to the 'From' address to use, if not the
email's 'From'
=cut
@@ -401,7 +413,7 @@
=item C<$SMTPDebug>
-$SMTPDebug should be set to true to debug SMTP mail sending
+C<$SMTPDebug> should be set to true to debug SMTP mail sending
=cut
@@ -409,13 +421,13 @@
=back
-=head1 Other mailer configuration
+=head1 Other Mailer Configuration
=over 4
=item C<@MailParams>
- at MailParams defines a list of options passed to $MailCommand if it
+C<@MailParams> defines a list of options passed to $MailCommand if it
is not 'sendmailpipe', 'sendmail', or 'smtp'
=cut
@@ -427,7 +439,7 @@
RT is designed such that any mail which already has a ticket-id associated
with it will get to the right place automatically.
-$CorrespondAddress and $CommentAddress are the default addresses
+C<$CorrespondAddress> and C<$CommentAddress> are the default addresses
that will be listed in From: and Reply-To: headers of correspondence
and comment mail tracked by RT, unless overridden by a queue-specific
address.
@@ -441,7 +453,7 @@
=item C<UseFriendlyFromLine>
By default, RT sets the outgoing mail's "From:" header to
-"SenderName via RT". Setting UseFriendlyFromLine to 0 disables it.
+"SenderName via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
=cut
@@ -449,7 +461,7 @@
=item C<$FriendlyFromLineFormat>
-sprintf() format of the friendly 'From:' header; its arguments
+C<sprintf()> format of the friendly 'From:' header; its arguments
are SenderName and SenderEmailAddress.
=cut
@@ -471,7 +483,7 @@
=item C<$FriendlyToLineFormat>
-sprintf() format of the friendly 'From:' header; its arguments
+C<sprintf()> format of the friendly 'From:' header; its arguments
are WatcherType and TicketId.
=cut
@@ -482,7 +494,7 @@
By default, RT doesn't notify the person who performs an update, as they
already know what they've done. If you'd like to change this behaviour,
-Set $NotifyActor to 1
+Set C<$NotifyActor> to 1
=cut
@@ -491,7 +503,7 @@
=item C<$RecordOutgoingEmail>
By default, RT records each message it sends out to its own internal database.
-To change this behavior, set $RecordOutgoingEmail to 0
+To change this behavior, set C<$RecordOutgoingEmail> to 0
=cut
@@ -500,10 +512,12 @@
=item C<$VERPPrefix>, C<$VERPPrefix>
VERP support (http://cr.yp.to/proto/verp.txt)
+
uncomment the following two directives to generate envelope senders
-of the form ${VERPPrefix}${originaladdress}@${VERPDomain}
-(i.e. rt-jesse=fsck.com at rt.example.com ) This currently only works
-with sendmail and sendmailppie.
+of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
+(i.e. rt-jesse=fsck.com at rt.example.com ).
+
+This currently only works with sendmail and sendmailppie.
=cut
@@ -515,7 +529,8 @@
By default, RT forwards a message using queue's address and adds RT's tag into
subject of the outgoing message, so recipients' replies go into RT as correspondents.
-To change this behavior, set $ForwardFromUser to true value and RT will use
+
+To change this behavior, set C<$ForwardFromUser> to true value and RT will use
address of the current user and leave subject without RT's tag.
=cut
@@ -525,7 +540,9 @@
=item C<$ShowBccHeader>
By default RT hides from the web UI information about blind copies user sent on
-reply or comment, to change this set the following option to true value
+reply or comment.
+
+To change this set the following option to true value.
=cut
@@ -533,7 +550,7 @@
=back
-=head1 GnuPG
+=head1 GnuPG Configuration
A full description of the (somewhat extensive) GnuPG integration can be found
by running the command `perldoc L<RT::Crypt::GnuPG>` (or `perldoc
@@ -560,8 +577,10 @@
=item C<%GnuPGOptions>
Options of GnuPG program.
+
If you override this in your RT_SiteConfig, you should be sure
-to include a homedir setting
+to include a homedir setting.
+
NOTE that options with '-' character MUST be quoted.
=cut
@@ -582,10 +601,10 @@
=back
-=head1 Logging
+=head1 Logging Configuration
The default is to log anything except debugging
-information to syslog. Check the Log::Dispatch POD for
+information to syslog. Check the L<Log::Dispatch> POD for
information about how to get things by syslog, mail or anything
else, get debugging info in the log, etc.
@@ -637,9 +656,9 @@
=item C<@LogToSyslogConf>
On Solaris or UnixWare, set to ( socket => 'inet' ). Options here
-override any other options RT passes to Log::Dispatch::Syslog.
+override any other options RT passes to L<Log::Dispatch::Syslog>.
Other interesting flags include facility and logopt. (See the
-Log::Dispatch::Syslog documentation for more information.) (Maybe
+L<Log::Dispatch::Syslog> documentation for more information.) (Maybe
ident too, if you have multiple RT installations.)
=cut
@@ -649,7 +668,7 @@
=item C<$StatementLog>,
RT has rudimentary SQL statement logging support if you have
-DBIx-SearchBuilder 1.31_1 or higher; simply set $StatementLog to be
+DBIx-SearchBuilder 1.31_1 or higher; simply set C<$StatementLog> to be
the level that you wish SQL statements to be logged at.
=cut
@@ -658,7 +677,7 @@
=back
-=head1 Web interface configuration
+=head1 Web Interface Configuration
=over 4
@@ -671,7 +690,7 @@
3.4-compat A 3.4 compatibility stylesheet to make RT 3.5 look
(mostly) like 3.4
-This value actually specifies a directory in share/html/NoAuth/css/
+This value actually specifies a directory in F<share/html/NoAuth/css/>
from which RT will try to load the file main.css (which should
@import any other files the stylesheet needs). This allows you to
easily and cleanly create your own stylesheets to apply to RT. This
@@ -684,11 +703,12 @@
=item C<$WebPath>
If you're putting the web ui somewhere other than at the root of
-your server, you should set $WebPath to the path you'll be
+your server, you should set C<$WebPath> to the path you'll be
serving RT at.
-$WebPath requires a leading / but no trailing /.
-In most cases, you should leave $WebPath set to '' (an empty value).
+C<$WebPath> requires a leading / but no trailing /.
+
+In most cases, you should leave C<$WebPath> set to '' (an empty value).
=cut
@@ -714,7 +734,7 @@
=item C<$WebBaseURL>, C<$WebURL>
This is the Scheme, server and port for constructing urls to webrt
-$WebBaseURL doesn't need a trailing /
+C<$WebBaseURL> doesn't need a trailing /
=cut
@@ -724,7 +744,7 @@
=item C<$WebImagesURL>
-$WebImagesURL points to the base URL where RT can find its images.
+C<$WebImagesURL> points to the base URL where RT can find its images.
Define the directory name to be used for images in rt web
documents.
@@ -734,7 +754,7 @@
=item C<$LogoURL>
-$LogoURL points to the URL of the RT logo displayed in the web UI
+C<$LogoURL> points to the URL of the RT logo displayed in the web UI
=cut
@@ -742,8 +762,7 @@
=item C<$WebNoAuthRegex>
-WebNoAuthRegex - What portion of RT's URLspace should not require
-authentication.
+What portion of RT's URLspace should not require authentication.
=cut
@@ -814,7 +833,7 @@
=item C<$PreferRichText>
-If PreferRichText is set to a true value, RT will show HTML/Rich text
+If C<$PreferRichText> is set to a true value, RT will show HTML/Rich text
messages in preference to their plaintext alternatives. RT "scrubs" the
html to show only a minimal subset of HTML to avoid possible contamination
by cross-site-scripting attacks.
@@ -863,8 +882,8 @@
If C<$WebExternalAuto> is true, C<$AutoCreate> will be passed to User's
Create method. Use it to set defaults, such as creating
-Unprivileged users with { Privileged => 0 }
-Must be a hashref of arguments
+Unprivileged users with C<{ Privileged => 0 }>
+( Must be a hashref of arguments )
=cut
@@ -875,16 +894,16 @@
C<$WebSessionClass> is the class you wish to use for managing Sessions.
It defaults to use your SQL database, but if you are using MySQL 3.x and
plans to use non-ascii Queue names, uncomment and add this line to
-RT_SiteConfig.pm will prevent session corruption.
+F<RT_SiteConfig.pm> will prevent session corruption.
=cut
# Set($WebSessionClass , 'Apache::Session::File');
-=item C<AutoLogoff>
+=item C<$AutoLogoff>
By default, RT's user sessions persist until a user closes his or her
-browser. With the $AutoLogoff option you can setup session lifetime in
+browser. With the C<$AutoLogoff> option you can setup session lifetime in
minutes. A user will be logged out if he or she doesn't send any requests
to RT for the defined time.
@@ -905,12 +924,12 @@
Set($WebSecureCookies, 0);
-=item C<WebFlushDbCacheEveryRequest>
+=item C<$WebFlushDbCacheEveryRequest>
By default, RT clears its database cache after every page view.
This ensures that you've always got the most current information
when working in a multi-process (mod_perl or FastCGI) Environment
-Setting $WebFlushDbCacheEveryRequest to '0' will turn this off,
+Setting C<$WebFlushDbCacheEveryRequest> to '0' will turn this off,
which will speed RT up a bit, at the expense of a tiny bit of data
accuracy.
@@ -932,7 +951,7 @@
=item C<$DefaultSummaryRows>
-$DefaultSummaryRows is default number of rows displayed in for search
+C<$DefaultSummaryRows> is default number of rows displayed in for search
results on the frontpage.
=cut
@@ -961,7 +980,9 @@
=item C<$ShowUnreadMessageNotifications>
-By default, RT will prompt users when there are new, unread messages on tickets they are viewing
+By default, RT will prompt users when there are new, unread messages on
+tickets they are viewing.
+
Set C<$ShowUnreadMessageNotifications> to a false value to disable this feature.
=cut
@@ -983,8 +1004,10 @@
C<@MasonParameters> is the list of parameters for the constructor of
HTML::Mason's Apache or CGI Handler. This is normally only useful
for debugging, eg. profiling individual components with:
+
use MasonX::Profiler; # available on CPAN
@MasonParameters = (preamble => 'my $p = MasonX::Profiler->new($m, $r);');
+
=cut
Set(@MasonParameters, ());
@@ -1033,7 +1056,7 @@
=item C<$ChartFont>
-The GD module (which RT uses for graphs) uses a builtin font that doesn't
+The L<GD> module (which RT uses for graphs) uses a builtin font that doesn't
have full Unicode support. You can use a particular TrueType font by setting
$ChartFont to the absolute path of that font. Your GD library must have
support for TrueType fonts to use this option.
@@ -1065,7 +1088,7 @@
=back
-=head1 Net::Server (rt-server) configuration
+=head1 L<Net::Server> (rt-server) Configuration
=over 4
@@ -1083,8 +1106,8 @@
=item C<$StandaloneMinSpareServers>, C<$StandaloneMaxSpareServers>
These next two options can be used to scale up and down the number of servers
-to adjust to load. These two options will respect the $StandaloneMinServers
-and $StandaloneMaxServers options.
+to adjust to load. These two options will respect the C<$StandaloneMinServers
+> and C<$StandaloneMaxServers options>.
=cut
@@ -1106,7 +1129,8 @@
C<%NetServerOptions> is a hash of additional options to use for
L<Net::Server/DEFAULT ARGUMENTS>. For example, you could set
reverse_lookups to get the hostnames for all users with:
-Set(%NetServerOptions, (reverse_lookups => 1));
+
+C<Set(%NetServerOptions, (reverse_lookups => 1));>
=cut
@@ -1115,14 +1139,14 @@
=back
-=head1 RT UTF-8 Settings
+=head1 UTF-8 Configuration
=over 4
=item C<@LexiconLanguages>
An array that contains languages supported by RT's internationalization
-interface. Defaults to all *.po lexicons; setting it to qw(en ja) will make
+interface. Defaults to all *.po lexicons; setting it to C<qw(en ja)> will make
RT bilingual instead of multilingual, but will save some memory.
=cut
@@ -1133,7 +1157,7 @@
An array that contains default encodings used to guess which charset
an attachment uses if not specified. Must be recognized by
-Encode::Guess.
+L<Encode::Guess>.
=cut
@@ -1150,19 +1174,20 @@
=back
-=head1 RT Date Handling Options
+=head1 Date Handling Configuration
=over 4
=item C<$DateTimeFormat>
You can choose date and time format. See "Output formatters"
-section in perldoc lib/RT/Date.pm for more options. This option can
+section in perldoc F<lib/RT/Date.pm> for more options. This option can
be overridden by users in their preferences.
Some examples:
-Set($DateTimeFormat, { Format => 'ISO', Seconds => 0 });
-Set($DateTimeFormat, 'RFC2822');
-Set($DateTimeFormat, { Format => 'RFC2822', Seconds => 0, DayOfWeek => 0 });
+
+C<Set($DateTimeFormat, { Format => 'ISO', Seconds => 0 });>
+C<Set($DateTimeFormat, 'RFC2822');>
+C<Set($DateTimeFormat, { Format => 'RFC2822', Seconds => 0, DayOfWeek => 0 });>
=cut
@@ -1185,8 +1210,11 @@
past value? For example, should a date of "Tuesday" default to mean
the date for next Tuesday or last Tuesday? Should the date "March 1"
default to the date for next March or last March?
-Set AmbiguousDayInPast for the last date, or AmbiguousDayInFuture for the
-next date. The default is usually good.
+
+Set $<AmbiguousDayInPast> for the last date, or $<$AmbiguousDayInFuture> for the
+next date.
+
+The default is usually good.
=cut
@@ -1195,7 +1223,7 @@
=back
-=head1 Miscellaneous RT Settings
+=head1 Miscellaneous Configuration
=over 4
@@ -1211,7 +1239,7 @@
Set(@ActiveStatus, qw(new open stalled));
Set(@InactiveStatus, qw(resolved rejected deleted));
-=item C<LinkTransactionsRun1Scrip>
+=item C<$LinkTransactionsRun1Scrip>
RT-3.4 backward compatibility setting. Add/Delete Link used to record one
transaction and run one scrip. Set this value to 1 if you want
@@ -1223,7 +1251,7 @@
=item C<$StrictLinkACL>
-When this feature is enabled a user needs ModifyTicket rights on both
+When this feature is enabled a user needs I<ModifyTicket> rights on both
tickets to link them together, otherwise he can have rights on either of
them.
@@ -1242,7 +1270,7 @@
=item C<$UseTransactionBatch>
-Set $UseTransactionBatch to 1 to execute transactions in batches,
+Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
such that a resolve and comment (for example) would happen
simultaneously, instead of as two transactions, unaware of each
others' existence.
@@ -1253,8 +1281,8 @@
=item C<@CustomFieldValuesSources>
-Set @CustomFieldValuesSources to a list of class names which extend
-RT::CustomFieldValues::External. This can be used to pull lists of
+Set C<@CustomFieldValuesSources> to a list of class names which extend
+L<RT::CustomFieldValues::External>. This can be used to pull lists of
custom field values from external sources at runtime.
=cut
@@ -1264,7 +1292,8 @@
=item C<$CanonicalizeRedirectURLs>
Set C<$CanonicalizeRedirectURLs> to 1 to use $C<WebURL> when redirecting rather
-than the one we get from %ENV.
+than the one we get from C<%ENV>.
+
If you use RT behind a reverse proxy, you almost certainly want to
enable this option.
@@ -1295,7 +1324,7 @@
=back
-=head1 Development Mode
+=head1 Development Configuration
=over 4
@@ -1319,11 +1348,11 @@
=back
-=head1 Deprecated options
+=head1 Deprecated Options
=over 4
-=item C<AlwaysUseBase64>
+=item C<$AlwaysUseBase64>
Encode blobs as base64 in DB (?)
More information about the Rt-commit
mailing list