.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "INTERCHANGE 1p" .TH INTERCHANGE 1p "2012-01-23" "perl v5.14.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" interchange \- an e\-commerce and general HTTP database display system .SH "SYNOPSIS" .IX Header "SYNOPSIS" interchange [\-\-options] [file] .SH "VERSION" .IX Header "VERSION" 5.7.7 .SH "DESCRIPTION" .IX Header "DESCRIPTION" Interchange is a database access and retrieval system focused on e\-commerce. It allows customers to select items to buy from catalog pages. The program tracks user information in sessions and interacts with an \s-1HTTP\s0 server through sockets. .PP Interchange has many, many, functions and features; they are too numerous to describe in this venue. Complete information can be found at its web site: .PP .Vb 1 \& http://www.icdevgroup.org/ .Ve .PP Interchange requires Perl 5.8.5 or higher; more information on Perl can be seen at: .PP .Vb 1 \& http://www.perl.com/ .Ve .SH "OPTIONS" .IX Header "OPTIONS" Interchange uses the Getopt::Long module, and most options will be recognized if they uniquely identifiable. The canonical forms are: .IP "\-a, \-\-add" 4 .IX Item "-a, --add" Add a catalog to the system. Information taken from the input file (or standard input). Implies reconfig=catalog. Example: .Sp .Vb 1 \& echo "Catalog simple /catalogs/simple /simple.cgi" | bin/interchange \-a .Ve .Sp The information is in the form of a standard Interchange catalog line, and must be in the single-line format. .IP "\-\-runjobs=catalog[=job]" 4 .IX Item "--runjobs=catalog[=job]" Run a jobs group which is a series of files in a directory with the name corresponding to the \f(CW\*(C`job\*(C'\fR. For instance, if you set up a directory called \*(L"weekly\*(R" in your pages directory for the catalog \f(CW\*(C`foundation\*(C'\fR, you can run those files with: .Sp .Vb 1 \& interchange \-\-runjobs=foundation=weekly .Ve .Sp Files ending in .html (or whatever HTMLsuffix is for that catalog) are skipped. It is not tree-recursive \*(-- directories are ignored. .Sp Results can be emailed to an address if you specify \-\-email=address, and they will be put in the jobs log file. .Sp Alternatively jobs can be specified with \-\-jobgroup=jobname \fBbefore\fR the \-\-runjobs option. In other words, this will work: .Sp .Vb 1 \& interchange \-\-jobgroup=weekly \-\-runjobs=foundation .Ve .Sp This will \s-1NOT\s0 work: .Sp .Vb 1 \& interchange \-\-runjobs=foundation \-\-jobgroup=weekly .Ve .IP "\-d dir, \-\-dir=dir" 4 .IX Item "-d dir, --dir=dir" Directory for VendRoot. This is where the Interchange configuration file will be looked for (if not redefined with \f(CW\*(C`\-f\*(C'\fR), and where the log file will go (if not redefined with the ErrorFile directive). .IP "\-e name, \-\-exclude=name" 4 .IX Item "-e name, --exclude=name" Exclude catalog from this startup. .IP "\-email=address" 4 .IX Item "-email=address" Email address to email jobs results to. .IP "\-f file, \-\-config=file" 4 .IX Item "-f file, --config=file" Configuration file to use (default is interchange.cfg in VendRoot). .IP "\-h, \-\-help" 4 .IX Item "-h, --help" Display help on command line options. .IP "\-i, \-\-inetmode" 4 .IX Item "-i, --inetmode" Run with internet-domain socket only. Normally Interchange runs with both \s-1UNIX\-\s0 and internet-domain sockets (except on Windows). .IP "\-\-jobgroup=job" 4 .IX Item "--jobgroup=job" Sets the job for \-\-runjobs if that is not included in the \-\-runjobs call. \s-1MUST\s0 precede the \-\-runjobs entry on the command line. .Sp .Vb 1 \& interchange \-\-jobgroup=weekly \-\-runjobs=foundation .Ve .Sp See \-\-runjobs for an explanation of what this does. .IP "\-\-kill [signal]" 4 .IX Item "--kill [signal]" By default, kills the server ungracefully with signal \s-1KILL\s0 (9, usually). The optional signal will be sent instead if supplied. .IP "\-q, \-\-quiet" 4 .IX Item "-q, --quiet" Suppress informational messages on startup. Only errors are shown. .IP "\-\-reconfig=name" 4 .IX Item "--reconfig=name" Cause only catalog \f(CW\*(C`name\*(C'\fR to re-read its configuration. .IP "\-\-remove=catalog" 4 .IX Item "--remove=catalog" Remove a catalog from operation; any future requests will get a not-found message. .IP "\-r, \-\-restart" 4 .IX Item "-r, --restart" Stop and restart the server. This may take a long time if many catalogs are in use, and will temporarily take the system offline. If you want to change a UserTag, use the \-\-add option instead. .IP "\-\-serve" 4 .IX Item "--serve" This is the default if no mode options (\-\-reconfig, \-\-kill, \-\-restart, etc.) are supplied. .IP "\-\-stop" 4 .IX Item "--stop" Stop server gracefully with a \s-1TERM\s0 signal. .IP "\-t, \-\-test" 4 .IX Item "-t, --test" Report problems with config files; causes a complete configuration of the Interchange server but no server start. .IP "\-u, \-\-unix" 4 .IX Item "-u, --unix" Run with unix-domain socket only. Normally Interchange runs with both \s-1UNIX\-\s0 and internet-domain sockets. This will not work on Windows. .IP "\-v, \-\-version" 4 .IX Item "-v, --version" Display program version. .IP "\-\-DEBUG=1" 4 .IX Item "--DEBUG=1" Set to true value to run foreground in debug mode. It is normal to receive warnings about various things if you run with perl \-w. .IP "Directive=value" 4 .IX Item "Directive=value" Set a Interchange global directive upon start (or \-\-restart). Example: .Sp .Vb 1 \& interchange SocketPerms=0666 .Ve .Sp This will start the server and override the default of SocketPerms or the value set in interchange.cfg for this instance only. Any \-\-restarts must re-specify the directive if it is still to have that value. .IP "name:Directive=value" 4 .IX Item "name:Directive=value" Set a Interchange directive for catalog \f(CW\*(C`name\*(C'\fR upon start (or \-\-restart). Example: .Sp .Vb 1 \& interchange simple:VendURL="http://localhost/cgi\-bin/simple" .Ve .Sp This will start the server and override the default of VendURL for the value set in catalog.cfg for this instance only. Any \-\-restarts must re-specify the directive if it is still to have that value. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIcompile_link\fR\|(1), \fIconfig_prog\fR\|(1), \fIconfigdump\fR\|(1), \fIdump\fR\|(1), \fIexpire\fR\|(1), \&\fIexpireall\fR\|(1), \fIlocalize\fR\|(1), \fImakecat\fR\|(1), \fIoffline\fR\|(1), \fIrestart\fR\|(1), \fIupdate\fR\|(1), http://www.icdevgroup.org/ .SH "LICENSE" .IX Header "LICENSE" Interchange comes with \s-1ABSOLUTELY\s0 \s-1NO\s0 \s-1WARRANTY\s0. This is free software, and you are welcome to redistribute and modify it under the terms of the \&\s-1GNU\s0 General Public License. .SH "COPYRIGHT" .IX Header "COPYRIGHT" .Vb 3 \& Copyright (C) 2002\-2011 Interchange Development Group \& Copyright (C) 1995\-2002 Red Hat, Inc. \& All rights reserved except those granted in the license. .Ve .SH "AUTHOR" .IX Header "AUTHOR" Mike Heins is the primary author of Interchange. .PP The Interchange Development Group is: .PP .Vb 10 \& Daniel Browning \& David Christensen \& Gert van der Spoel \& Greg Hanson \& Jon Jensen \& Jure Kodzoman \& Mark Johnson \& Mark Lipscombe \& Mike Heins \& Peter Ajamian \& Ron Phipps \& Stefan Hornburg (aka Racke), captain \& Ton Verhagen .Ve .PP Please do not contact the authors directly for help with the system. Use the Interchange mail list: .PP .Vb 1 \& interchange\-users@icdevgroup.org .Ve .PP Information on subscribing to the list, as well as general information and documentation for Interchange is at: .PP .Vb 1 \& http://www.icdevgroup.org/ .Ve .SH "ACKNOWLEDGEMENTS" .IX Header "ACKNOWLEDGEMENTS" Original author of Vend, ancestor to Minivend and Interchange, was Andrew Wilcox . Interchange could never have come into being without him. Interchange was based on Vend 0.2, with portions from Vend 0.3; both were produced in 1995. .PP Special thanks to Retired Core Team Members: .PP .Vb 10 \& Brev Patterson \& David Kelly \& Davor Ocelic \& Ed LaFrance \& Ethan Rowe \& Jonathan Clark \& JT Justman \& Kevin Walsh \& Paul Vinciguerra \& Randy Moore .Ve .PP Contributions to Interchange have been made by: .PP .Vb 10 \& Alison Smith Jonathan Walker \& Andreas Koenig Jordan Adler \& Andrew Rich Josh Braegger \& Bill Carr Josh Lavin \& Bill Dawkins Jose\*' MX Revuelto \& Bill Randle Jurgen Botz \& Birgitt Funk Justin Otten \& Bob Jordan Kaare Rasmussen \& Brent Kelly Keiko \& Brian Bullen Keith Oberlin \& Brian Kosick Kim Lauritz Christensen \& Brian Miller Larry Huffman \& Bruce Albrecht Larry Leszczynski \& Cameron Prince Lars Tode \& Carl Bailey Lyn St George \& Chen Naor Marc Austin \& Christian Mueller Mark Stosberg \& Christopher Miller Marty Tennison \& Christopher Thompson Massimiliano Ciancio \& Christopher Wenham Mat Jones \& Dan Busarow Matthew Schick \& Dan Collis\-Puro Max Cohan \& Dan Helfman Michael Lehmkuhl \& Daniel Hutchinson Michael McCune \& Daniel Thompson Michael Wilk \& Dave Wingate Mick Weiss \& David Adams Mike Frager \& Dennis Cronin Neil Evans \& Don Grodecki Nelson Ferrari \& Don Hathaway Paul Delys \& Donald Alexander Paul Jordan \& Eric Zarko Phil Smith \& Frank Bonita Raj Goel \& Frederic Steinfels Ray Desjardins \& Gary Benson Reid Sutherland \& Gunnar Hellekson Rene\*' Hertell \& Hamish Bradick Ryan Perry \& Hans\-Joachim Leidinger Sergiusz Jarczyk \& Heinz Wittenbecher Shozo Murahashi \& Hiroyuki Cozy Kojima Sonny Cook \& Ignacio Lizara\*'n Spencer Christensen \& Ivan Kohler Steve Graham \& Jack Tsai Thomas J.M. Burton \& Jason Holt Tim Baverstock \& Jason Kohles Tom Friedel \& Javier Martin Tom Tucker \& Jeff Barr Tommi Labermo \& Jeff Boes Toni Mueller \& Jeff Carnahan Troy Davis \& Jeff Fearn Victor Nolton \& Jeff Nappi William Dan Terry \& Jochen Wiedmann Zachary Matthews \& \& and many others. .Ve .PP And, of course, the entire Perl team without whom Interchange could not exist.