'\"
'\" The contents of this file are subject to the AOLserver Public License
'\" Version 1.1 (the "License"); you may not use this file except in
'\" compliance with the License. You may obtain a copy of the License at
'\" http://aolserver.com/.
'\"
'\" Software distributed under the License is distributed on an "AS IS"
'\" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
'\" the License for the specific language governing rights and limitations
'\" under the License.
'\"
'\" The Original Code is AOLserver Code and related documentation
'\" distributed by AOL.
'\" 
'\" The Initial Developer of the Original Code is America Online,
'\" Inc. Portions created by AOL are Copyright (C) 1999 America Online,
'\" Inc. All Rights Reserved.
'\"
'\" Alternatively, the contents of this file may be used under the terms
'\" of the GNU General Public License (the "GPL"), in which case the
'\" provisions of GPL are applicable instead of those above.  If you wish
'\" to allow use of your version of this file only under the terms of the
'\" GPL and not to allow others to use your version of this file under the
'\" License, indicate your decision by deleting the provisions above and
'\" replace them with the notice and other provisions required by the GPL.
'\" If you do not delete the provisions above, a recipient may use your
'\" version of this file under either the License or the GPL.
'\" 
'\"
'\" $Header: /cvsroot/aolserver/aolserver/doc/Ns_Info.3,v 1.6 2006/04/19 17:37:30 jgdavidson Exp $
'\"
'\" 
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",
'\"	or "in/out" to describe whether procedure reads or modifies arg,
'\"	and indent is equivalent to second arg of .IP (shouldn't ever be
'\"	needed;  use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\"	Give maximum sizes of arguments for setting tab stops.  Type and
'\"	name are examples of largest possible arguments that will be passed
'\"	to .AP later.  If args are omitted, default tab stops are used.
'\"
'\" .BS
'\"	Start box enclosure.  From here until next .BE, everything will be
'\"	enclosed in one large box.
'\"
'\" .BE
'\"	End of box enclosure.
'\"
'\" .CS
'\"	Begin code excerpt.
'\"
'\" .CE
'\"	End code excerpt.
'\"
'\" .VS ?version? ?br?
'\"	Begin vertical sidebar, for use in marking newly-changed parts
'\"	of man pages.  The first argument is ignored and used for recording
'\"	the version when the .VS was added, so that the sidebars can be
'\"	found and removed when they reach a certain age.  If another argument
'\"	is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\"	End of vertical sidebar.
'\"
'\" .DS
'\"	Begin an indented unfilled display.
'\"
'\" .DE
'\"	End of indented unfilled display.
'\"
'\" .SO
'\"	Start of list of standard options for a Tk widget.  The
'\"	options follow on successive lines, in four columns separated
'\"	by tabs.
'\"
'\" .SE
'\"	End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\"	Start of description of a specific option.  cmdName gives the
'\"	option's name as specified in the class command, dbName gives
'\"	the option's name in the option database, and dbClass gives
'\"	the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\"	Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.1 2006/06/26 00:29:11 jgdavidson Exp $
'\"
'\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
'\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1	\\fI\\$2\\fP	(\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
'\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
'\"	# BS - start boxed text
'\"	# ^y = starting y location
'\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
'\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
'\"	# VS - start vertical sidebar
'\"	# ^Y = starting y location
'\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
'\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
'\"	# Special macro to handle page bottom:  finish off current
'\"	# box/sidebar if in box/sidebar mode, then invoked standard
'\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
'\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
'\"	# DE - end display
.de DE
.fi
.RE
.sp
..
'\"	# SO - start of list of standard options
.de SO
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
'\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\fBoptions\\fR manual entry for details on the standard options.
..
'\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
'\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
'\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..

.TH Ns_Info 3aolserver 4.0 AOLserver "AOLserver Library Procedures"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
Ns_InfoAddress, Ns_InfoBootTime, Ns_InfoBuildDate, Ns_InfoConfigFile, Ns_InfoErrorLog, Ns_InfoHomePath, Ns_InfoHostname, Ns_InfoLabel, Ns_InfoNameOfExecutable, Ns_InfoPid, Ns_InfoPlatform, Ns_InfoServerName, Ns_InfoServerVersion, Ns_InfoServersStarted, Ns_InfoShutdownPending, Ns_InfoStarted, Ns_InfoTag, Ns_InfoUptime, Ns_PageRoot \- Get server information
.SH SYNOPSIS
.nf
\fB#include "ns.h"\fR
.sp
char *
\fBNs_InfoAddress\fR(\fIvoid\fR)
.sp
int
\fBNs_InfoBootTime\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoBuildDate\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoConfigFile\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoErrorLog\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoHomePath\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoHostname\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoLabel\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoNameOfExecutable\fR(\fIvoid\fR)
.sp
int
\fBNs_InfoPid\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoPlatform\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoServerName\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoServerVersion\fR(\fIvoid\fR)
.sp
int
\fBNs_InfoServersStarted\fR(\fIvoid\fR)
.sp
int
\fBNs_InfoShutdownPending\fR(\fIvoid\fR)
.sp
int
\fBNs_InfoStarted\fR(\fIvoid\fR)
.sp
char *
\fBNs_InfoTag\fR(\fIvoid\fR)
.sp
int
\fBNs_InfoUptime\fR(\fIvoid\fR)
.sp
char *
\fBNs_PageRoot\fR(\fIchar *server\fR)
.BE

.SH DESCRIPTION
.PP
These functions return information about the server.

Many of the functions return pointers to strings or other types of
information which, in most cases, you must not free. These are denoted
as "read-only" in the sections below.

.TP
\fBNs_InfoAddress\fR()
Return the server IP address of the server. The IP address is defined
in the server configuration file. The IP address is returned as a
string pointer which you must treat as read-only. If you want to
alter the string, you must use \fBns_strdup\fR to copy the string
to another location in memory and modify that instead.

.TP
\fBNs_InfoBootTime\fR()
Return the time that the server was started as an int. Treat the
result as time_t.

.TP
\fBNs_InfoBuildDate\fR()
Return the date and time that this server was compiled as a string
pointer. Treat the result as read-only.

.TP
\fBNs_InfoConfigFile\fR()
Return the absolute path name of the configuration file in use as
a string pointer. Treat the result as read-only.

.TP
\fBNs_InfoErrorLog\fR()
Return the name of the error log as a string pointer. Treat the
result as read-only. The name may be just a name, a relative path
or an absolute path depending on how it is defined in the server
configuration file.

.TP
\fBNs_InfoHomePath\fR()
Return the absolute directory path where AOLserver is installed as
a string pointer. Treat the result as read-only.

.TP
\fBNs_InfoHostname\fR()
Return the hostname of the host that AOLserver is running on as a
string pointer. The \fBgethostname\fR(2) function is used. If
\fBgethostname\fR(2) fails to return a hostname, "localhost" is
used instead. Treat the result as read-only.

.TP
\fBNs_InfoLabel\fR()
Return the source code label for AOLserver as a string pointer.
Statically defined in the source code. If no label was used,
"unlabeled" is returned. You can use these functions to provide the
source code label when you report problems with the server. Treat
the result as read-only.

.TP
\fBNs_InfoNameOfExecutable\fR()
Return the name of the running executable as a string pointer. Treat
the result as read-only.

.TP
\fBNs_InfoPid\fR()
Return the pid of the running AOLserver executable as an int.

.TP
\fBNs_InfoPlatform\fR()
Return the platform name as a string pointer, e.g. "linux". Treat
the result as read-only.

.TP
\fBNs_InfoServerName\fR()
Return the AOLserver name string, e.g. "AOLserver". Statically
defined in the source code. Treat the result as read-only.

.TP
\fBNs_InfoServerVersion\fR()
Return the AOLserver version string, e.g. "3.5.2". Statically defined
in the source code. Treat the result as read-only.

.TP
\fBNs_InfoServersStarted\fR()
Return TRUE if the server has started, i.e., if initialization and
module loading is complete. This is a compatibility function that
calls \fBNs_InfoStarted\fR.

.TP
\fBNs_InfoShutdownPending\fR()
Return TRUE if there is there a shutdown pending, i.e. if an INTR
signal has been received or if \fBns_shutdown\fR has been called.

.TP
\fBNs_InfoStarted\fR()
Return TRUE if the server has started, i.e., if initialization and
module loading is complete.

.TP
\fBNs_InfoTag\fR()
Return the CVS tag of this build of AOLserver. Statically defined
in the source code. The value may be meaningless. Treat the result
as read-only.

.TP
\fBNs_InfoUptime\fR()
Return how long, in seconds, AOLserver has been running.

.TP
\fBNs_PageRoot\fR(\fIserver\fR)
Return the path name of the AOLserver pages directory for a particular
server as a string pointer. The \fIserver\fR argument is not used.
Treat the result as read-only.

.SH "SEE ALSO"
nsd(1), info(n)

.SH KEYWORDS