diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/SMlib.xml | 340 |
1 files changed, 170 insertions, 170 deletions
diff --git a/doc/SMlib.xml b/doc/SMlib.xml index 66fedd2..90c3b15 100644 --- a/doc/SMlib.xml +++ b/doc/SMlib.xml @@ -42,16 +42,16 @@ <title>Overview of Session Management</title> <abstract> -<para>The purpose of the X Session Management Protocol (XSMP) is to provide a uniform mechanism for users to save and restore their sessions. A <emphasis remap='I'>session</emphasis> is a group of clients, each of which has a particular state. The session is controlled by a network service called the <emphasis remap='I'>session manager</emphasis>. The session manager issues commands to its clients on behalf of the user. These commands may cause clients to save their state or to terminate. It is expected that the client will save its state in such a way that the client can be restarted at a later time and resume its operation as if it had never been terminated. A client's state might include information about the file currently being edited, the current position of the insertion point within the file, or the start of an uncommitted transaction. The means by which clients are restarted is unspecified by this protocol.</para> +<para>The purpose of the X Session Management Protocol (<acronym>XSMP</acronym>) is to provide a uniform mechanism for users to save and restore their sessions. A <firstterm>session</firstterm> is a group of clients, each of which has a particular state. The session is controlled by a network service called the <firstterm>session manager</firstterm>. The session manager issues commands to its clients on behalf of the user. These commands may cause clients to save their state or to terminate. It is expected that the client will save its state in such a way that the client can be restarted at a later time and resume its operation as if it had never been terminated. A client's state might include information about the file currently being edited, the current position of the insertion point within the file, or the start of an uncommitted transaction. The means by which clients are restarted is unspecified by this protocol.</para> -<para>For purposes of this protocol, a <emphasis remap='I'>client</emphasis> of the session manager is defined as a connection to the session manager. A client is typically, though not necessarily, a process running an application program connected to an X display. However, a client may be connected to more than one X display or not be connected to any X displays at all.</para> +<para>For purposes of this protocol, a <firstterm>client</firstterm> of the session manager is defined as a connection to the session manager. A client is typically, though not necessarily, a process running an application program connected to an X display. However, a client may be connected to more than one X display or not be connected to any X displays at all.</para> </abstract> </chapter> <chapter id='the_session_management_library'> <title>The Session Management Library</title> <abstract> -<para>The Session Management Library (SMlib) is a low-level "C" language interface to XSMP. It is expected that higher level toolkits, such as Xt, will hide many of the details of session management from clients. Higher level toolkits might also be developed for session managers to use, but no such effort is currently under way.</para> +<para>The Session Management Library (<abbrev>SMlib</abbrev>) is a low-level "C" language interface to XSMP. It is expected that higher level toolkits, such as Xt, will hide many of the details of session management from clients. Higher level toolkits might also be developed for session managers to use, but no such effort is currently under way.</para> </abstract> <para>SMlib has two parts to it:</para> @@ -60,9 +60,9 @@ <listitem><para>One set of functions for session managers to call</para></listitem> </itemizedlist> -<para>Some applications will use both sets of functions and act as <emphasis remap='I'>nested session managers</emphasis>. That is, they will be both a session manager and a client of another session. An example is a mail program that could start a text editor for editing the text of a mail message. The mail program is part of a regular session and, at the same time, is also acting as a session manager to the editor.</para> +<para>Some applications will use both sets of functions and act as <firstterm>nested session managers</firstterm>. That is, they will be both a session manager and a client of another session. An example is a mail program that could start a text editor for editing the text of a mail message. The mail program is part of a regular session and, at the same time, is also acting as a session manager to the editor.</para> -<para>Clients initialize by connecting to the session manager and obtaining a <emphasis remap='I'>client-ID</emphasis> that uniquely identifies them in the session. The session manager maintains a list of properties for each client in the session. These properties describe the client's environment and, most importantly, describe how the client can be restarted (via an <function>SmRestartCommand</function>. Clients are expected to save their state in such a way as to allow multiple instantiations of themselves to be managed independently. For example, clients may use their client-ID as part of a filename in which to store the state for a particular instantiation. The client-ID should be saved as part of the <function>SmRestartCommand</function> so that the client will retain the same ID after it is restarted.</para> +<para>Clients initialize by connecting to the session manager and obtaining a <firstterm>client-ID</firstterm> that uniquely identifies them in the session. The session manager maintains a list of properties for each client in the session. These properties describe the client's environment and, most importantly, describe how the client can be restarted (via an <function>SmRestartCommand</function>. Clients are expected to save their state in such a way as to allow multiple instantiations of themselves to be managed independently. For example, clients may use their client-ID as part of a filename in which to store the state for a particular instantiation. The client-ID should be saved as part of the <function>SmRestartCommand</function> so that the client will retain the same ID after it is restarted.</para> <para>Once the client initializes itself with the session manager, it must be ready to respond to messages from the session manager. For example, it might be asked to save its state or to terminate. In the case of a shutdown, the session manager might give each client a chance to interact with the user and cancel the shutdown.</para> </chapter> @@ -70,7 +70,7 @@ <chapter id='understanding_smlibs_dependence_on_ice'> <title>Understanding SMlib's Dependence on ICE</title> -<para>The X Session Management Protocol is layered on top of the Inter-Client Exchange (ICE) Protocol. The ICE protocol is designed to multiplex several protocols over a single connection. As a result, working with SMlib requires a little knowledge of how the ICE library works.</para> +<para>The X Session Management Protocol is layered on top of the Inter-Client Exchange (<acronym>ICE</acronym>) Protocol. The ICE protocol is designed to multiplex several protocols over a single connection. As a result, working with SMlib requires a little knowledge of how the ICE library works.</para> <para>The ICE library utilizes callbacks to process messages. When a client detects that there is data to read on an ICE connection, it should call the <function>IceProcessMessages</function> function. <function>IceProcessMessages</function> will read the message header and look at the major opcode in order to determine which protocol the message was intended for. The appropriate protocol library will then be triggered to unpack the message and hand it off to the client via a callback.</para> @@ -80,7 +80,7 @@ <para>On the session manager side, things work a bit differently. The session manager has complete control over the creation of ICE connections. The session manager has to first call <function>IceListenForConnections</function> in order to start listening for connections from clients. Once a connection attempt is detected, <function>IceAcceptConnection</function> must be called, and the session manager can simply add the new ICE file descriptor to the list of descriptors to call <function>select</function> on.</para> -<para>For further information on the library functions related to ICE connections, see the <emphasis remap='I'>Inter-Client Exchange Library</emphasis> standard.</para> +<para>For further information on the library functions related to ICE connections, see the <citetitle pubwork='article'>Inter-Client Exchange Library</citetitle> standard.</para> </chapter> <chapter id='header_files_and_library_name'> @@ -92,7 +92,7 @@ </chapter> <chapter id='session_management_client'> -<title>Session Management Client (Smc) Functions</title> +<title>Session Management Client (<acronym>Smc</acronym>) Functions</title> <para>This section discusses how Session Management clients:</para> @@ -134,45 +134,45 @@ <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>context</emphasis></term> + <term><parameter>context</parameter></term> <listitem><para>A pointer to an opaque object or NULL. Used to determine if an ICE connection can be shared (see <link linkend='context_sharing'>below</link>).</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>xsmp_major_rev</emphasis></term> + <term><parameter>xsmp_major_rev</parameter></term> <listitem><para>The highest major version of the XSMP the application supports.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>xsmp_minor_rev</emphasis></term> + <term><parameter>xsmp_minor_rev</parameter></term> <listitem><para>The highest minor version of the XSMP the application supports (for the specified xsmp_major_rev).</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>mask</emphasis></term> + <term><parameter>mask</parameter></term> <listitem><para>A mask indicating which callbacks to register.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>callbacks</emphasis></term> + <term><parameter>callbacks</parameter></term> <listitem><para>The callbacks to register. These callbacks are used to respond to messages from the session manager.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>previous_id</emphasis></term> + <term><parameter>previous_id</parameter></term> <listitem><para>The client ID from the previous session.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_id_ret</emphasis></term> + <term><parameter>client_id_ret</parameter></term> <listitem><para>The client ID for the current session is returned.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>error_length</emphasis></term> + <term><parameter>error_length</parameter></term> <listitem><para>Length of the error_string_ret argument passed in.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>error_string_ret</emphasis></term> + <term><parameter>error_string_ret</parameter></term> <listitem><para>Returns a null-terminated error message, if any. The error_string_ret argument points to user supplied memory. No more than error_length bytes are used.</para></listitem> </varlistentry> </variablelist> -<para>The network_ids_list argument is a null-terminated string containing a list of network IDs for the session manager, separated by commas. If network_ids_list is NULL, the value of the <function>SESSION_MANAGER</function> environment variable will be used. Each network ID has the following format:</para> +<para>The network_ids_list argument is a null-terminated string containing a list of network IDs for the session manager, separated by commas. If network_ids_list is NULL, the value of the <envar>SESSION_MANAGER</envar> environment variable will be used. Each network ID has the following format:</para> <informaltable pgwide='0' frame='none'> <tgroup cols='3' align='center'> @@ -182,17 +182,17 @@ <tbody> <row> <entry align='left'></entry> - <entry align='left'>tcp/<hostname>:<portnumber></entry> + <entry align='left'><literal>tcp/</literal><parameter><hostname></parameter><literal>:</literal><parameter><portnumber></parameter></entry> <entry align='left'>or</entry> </row> <row> <entry align='left'></entry> - <entry align='left'>decnet/<hostname>::<objname></entry> + <entry align='left'><literal>decnet/</literal><parameter><hostname></parameter><literal>::</literal><parameter><objname></parameter></entry> <entry align='left'>or</entry> </row> <row> <entry align='left'></entry> - <entry align='left'>local/<hostname>:<path></entry> + <entry align='left'><literal>local/</literal><parameter><hostname></parameter><literal>:</literal><parameter><path></parameter></entry> <entry align='left'></entry> </row> </tbody> @@ -209,7 +209,7 @@ <para id='context_sharing'>The context argument indicates how willing the client is to share the ICE connection with other protocols. If context is NULL, then the caller is always willing to share the connection. If context is not NULL, then the caller is not willing to use a previously opened ICE connection that has a different non-NULL context associated with it.</para> -<para>As previously discussed (<link linkend='understanding_smlibs_dependence_on_ice'>section 3, “Understanding SMlib's Dependence on ICE”</link>), the client will have to keep track of when ICE connections are created or destroyed (using <function>IceAddConnectionWatch</function> and <function>IceRemoveConnectionWatch</function> and will have to call <function>IceProcessMessages</function> each time a <function>select</function> shows that there is data to read on an ICE connection. For further information, see the <emphasis remap='I'>Inter-Client Exchange Library</emphasis> standard.</para> +<para>As previously discussed (<link linkend='understanding_smlibs_dependence_on_ice'>section 3, “Understanding SMlib's Dependence on ICE”</link>), the client will have to keep track of when ICE connections are created or destroyed (using <function>IceAddConnectionWatch</function> and <function>IceRemoveConnectionWatch</function> and will have to call <function>IceProcessMessages</function> each time a <function>select</function> shows that there is data to read on an ICE connection. For further information, see the <citetitle pubwork='article'>Inter-Client Exchange Library</citetitle> standard.</para> <para>The callbacks argument contains a set of callbacks used to respond to session manager events. The mask argument specifies which callbacks are set. All of the callbacks specified in this version of SMlib are mandatory. The mask argument is necessary in order to maintain backwards compatibility in future versions of the library.</para> @@ -270,28 +270,28 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>Client data specified when the callback was registered.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>save_type</emphasis></term> + <term><parameter>save_type</parameter></term> <listitem><para>Specifies the type of information that should be saved.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>shut_down</emphasis></term> + <term><parameter>shut_down</parameter></term> <listitem><para>Specifies if a shutdown is taking place.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>interact_style</emphasis></term> + <term><parameter>interact_style</parameter></term> <listitem><para>The type of interaction allowed with the user.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>fast</emphasis></term> - <listitem><para>if <emphasis remap="B">True</emphasis>, then client should save its state as quickly as possible.</para></listitem> + <term><parameter>fast</parameter></term> + <listitem><para>if <symbol>True</symbol>, then client should save its state as quickly as possible.</para></listitem> </varlistentry> </variablelist> @@ -329,11 +329,11 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>Client data specified when the callback was registered.</para></listitem> </varlistentry> </variablelist> @@ -357,11 +357,11 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>Client data specified when the callback was registered.</para></listitem> </varlistentry> </variablelist> @@ -383,11 +383,11 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>Client data specified when the callback was registered.</para></listitem> </varlistentry> </variablelist> @@ -410,15 +410,15 @@ typedef struct { </funcsynopsis> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>count</emphasis></term> + <term><parameter>count</parameter></term> <listitem><para>The number of reasons for closing the connection.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>reason_msgs</emphasis></term> + <term><parameter>reason_msgs</parameter></term> <listitem><para>The reasons for closing the connection.</para></listitem> </varlistentry> </variablelist> @@ -454,15 +454,15 @@ typedef struct { <para>The session management connection object.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>mask</emphasis></term> + <term><parameter>mask</parameter></term> <listitem><para>A mask indicating which callbacks to modify.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>callbacks</emphasis></term> + <term><parameter>callbacks</parameter></term> <listitem><para>The new callbacks.</para></listitem> </varlistentry> </variablelist> @@ -493,15 +493,15 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>num_proprs</emphasis></term> + <term><parameter>num_proprs</parameter></term> <listitem><para>The number of properties.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>props</emphasis></term> + <term><parameter>props</parameter></term> <listitem><para>The list of properties to set.</para></listitem> </varlistentry> </variablelist> @@ -524,15 +524,15 @@ typedef struct { </funcsynopsis> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>num_proprs</emphasis></term> + <term><parameter>num_proprs</parameter></term> <listitem><para>The number of properties.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>prop_names</emphasis></term> + <term><parameter>prop_names</parameter></term> <listitem><para>The list of properties to set.</para></listitem> </varlistentry> </variablelist> @@ -550,15 +550,15 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>prop_reply_proc</emphasis></term> + <term><parameter>prop_reply_proc</parameter></term> <listitem><para>The callback to be invoked when the properties reply comes back.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>This pointer to client data will be passed to the <function>SmcPropReplyProc</function> callback.</para></listitem> </varlistentry> </variablelist> @@ -579,19 +579,19 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>This pointer to client data will be passed to the <function>SmcPropReplyProc</function> callback.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>num_props</emphasis></term> + <term><parameter>num_props</parameter></term> <listitem><para>The number of properties returned.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>props</emphasis></term> + <term><parameter>props</parameter></term> <listitem><para>The list of properties returned.</para></listitem> </varlistentry> </variablelist> @@ -616,19 +616,19 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>dialog_type</emphasis></term> + <term><parameter>dialog_type</parameter></term> <listitem><para>The type of dialog the client wishes to present to the user.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>interact_proc</emphasis></term> + <term><parameter>interact_proc</parameter></term> <listitem><para>The callback to be invoked when the “Interact” message arrives from the session manager.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>This pointer to client data will be passed to the <function>SmcInteractProc</function> callback when the “Interact” message arrives.</para></listitem> </varlistentry> </variablelist> @@ -651,11 +651,11 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>Client data specified when the callback was registered.</para></listitem> </varlistentry> </variablelist> @@ -672,11 +672,11 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>cancel_shutdown</emphasis></term> + <term><parameter>cancel_shutdown</parameter></term> <listitem><para>If <function>True</function>, indicates that the user requests that the entire shutdown be cancelled.</para></listitem> </varlistentry> </variablelist> @@ -703,34 +703,34 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>save_type</emphasis></term> + <term><parameter>save_type</parameter></term> <listitem><para>Specifies the type of information that should be saved.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>shutdown</emphasis></term> + <term><parameter>shutdown</parameter></term> <listitem><para>Specifies if a shutdown is taking place.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>interact_style</emphasis></term> + <term><parameter>interact_style</parameter></term> <listitem><para>The type of interaction allowed with the user.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>fast</emphasis></term> + <term><parameter>fast</parameter></term> <listitem><para>If <function>True</function> the client should save its state as quickly as possible.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>global</emphasis></term> + <term><parameter>global</parameter></term> <listitem><para>Controls who gets the “Save Yourself.”</para></listitem> </varlistentry> </variablelist> <para>The save_type, shutdown, interact_style, and fast arguments are discussed in more detail in <link linkend='the_save_yourself_callback'>section 5.1.1, “The Save Yourself Callback.”</link></para> -<para>If global is set to <function>True</function> then the resulting “Save Yourself” should be sent to all clients in the session. For example, a vendor of a Uninterruptible Power Supply (UPS) might include a Session Management client that would monitor the status of the UPS and generate a fast shutdown if the power is about to be lost.</para> +<para>If global is set to <function>True</function> then the resulting “Save Yourself” should be sent to all clients in the session. For example, a vendor of a Uninterruptible Power Supply (<acronym>UPS</acronym>) might include a Session Management client that would monitor the status of the UPS and generate a fast shutdown if the power is about to be lost.</para> <para>If global is set to <function>False</function> then the “Save Yourself” should only be sent to the client that requested it.</para> </sect1> @@ -751,15 +751,15 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>save_type_phase2_proc</emphasis></term> + <term><parameter>save_type_phase2_proc</parameter></term> <listitem><para>The callback to be invoked when the “Save Yourself Phase 2” message arrives from the session manager.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>This pointer to client data will be passed to the <function>SmcSaveYourselfPhase2Proc</function> callback when the “Save Yourself Phase 2” message arrives.</para></listitem> </varlistentry> </variablelist> @@ -784,11 +784,11 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>success</emphasis></term> + <term><parameter>success</parameter></term> <listitem><para>If <function>True</function> the “Save Yourself” operation was completed successfully.</para></listitem> </varlistentry> </variablelist> @@ -852,7 +852,7 @@ typedef struct { </funcprototype> </funcsynopsis> -<para><function>SmcGetIceConnection</function> returns the ICE connection object associated with this session management connection object. The ICE connection object can be used to get some additional information about the connection. Some of the more useful functions which can be used on the IceConn are <function>IceConnectionNumber</function> <function>IceConnectionString</function> <function>IceLastSentSequenceNumber</function> <function>IceLastReceivedSequenceNumber</function> and <function>IcePing</function> For further information, see the <emphasis remap='I'>Inter-Client Exchange Library</emphasis> standard.</para> +<para><function>SmcGetIceConnection</function> returns the ICE connection object associated with this session management connection object. The ICE connection object can be used to get some additional information about the connection. Some of the more useful functions which can be used on the IceConn are <function>IceConnectionNumber</function> <function>IceConnectionString</function> <function>IceLastSentSequenceNumber</function> <function>IceLastReceivedSequenceNumber</function> and <function>IcePing</function> For further information, see the <citetitle pubwork='article'>Inter-Client Exchange Library</citetitle> standard.</para> </sect1> <sect1 id='error_handling'> @@ -888,41 +888,41 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>smc_conn</emphasis></term> + <term><parameter>smc_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>swap</emphasis></term> + <term><parameter>swap</parameter></term> <listitem><para>A flag that indicates if the specified values need byte swapping.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>offending_minor_opcode</emphasis></term> + <term><parameter>offending_minor_opcode</parameter></term> <listitem><para>The minor opcode of the offending message.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>offending_sequence_num</emphasis></term> + <term><parameter>offending_sequence_num</parameter></term> <listitem><para>The sequence number of the offending message.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>error_class</emphasis></term> + <term><parameter>error_class</parameter></term> <listitem><para>The error class of the offending message.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>severity</emphasis></term> + <term><parameter>severity</parameter></term> <listitem><para><function>IceCanContinue</function><function>IceFatalToProtocol</function> or <function>IceFatalToConnection</function></para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>values</emphasis></term> + <term><parameter>values</parameter></term> <listitem><para>Any additional error values specific to the minor opcode and class.</para></listitem> </varlistentry> </variablelist> -<para>Note that this error handler is invoked for protocol related errors. To install an error handler to be invoked when an IO error occurs, use <function>IceSetIOErrorHandler</function> For further information, see the <emphasis remap='I'>Inter-Client Exchange Library</emphasis> standard.</para> +<para>Note that this error handler is invoked for protocol related errors. To install an error handler to be invoked when an IO error occurs, use <function>IceSetIOErrorHandler</function> For further information, see the <citetitle pubwork='article'>Inter-Client Exchange Library</citetitle> standard.</para> </sect1> </chapter> <chapter id='session_management_server'> -<title>Session Management Server (Sms) Functions</title> +<title>Session Management Server (<acronym>Sms</acronym>) Functions</title> <para>This section discusses how Session Management servers:</para> @@ -964,38 +964,38 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>vendor</emphasis></term> + <term><parameter>vendor</parameter></term> <listitem><para>A string specifying the session manager vendor.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>release</emphasis></term> + <term><parameter>release</parameter></term> <listitem><para>A string specifying the session manager release number.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>new_client_proc</emphasis></term> + <term><parameter>new_client_proc</parameter></term> <listitem><para>Callback to be invoked each time a new client connects to the session manager.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>When the <function>SmsNewClientProc</function> callback is invoked, this pointer to manager data will be passed.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>host_based_auth_proc</emphasis></term> + <term><parameter>host_based_auth_proc</parameter></term> <listitem><para>Host based authentication callback.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>error_length</emphasis></term> + <term><parameter>error_length</parameter></term> <listitem><para>Length of the error_string_ret argument passed in.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>error_string_ret</emphasis></term> + <term><parameter>error_string_ret</parameter></term> <listitem><para>Returns a null-terminated error message, if any. The error_string_ret points to user supplied memory. No more than error_length bytes are used.</para></listitem> </varlistentry> </variablelist> <para>After the <function>SmsInitialize</function> function is called, the session manager should call the <function>IceListenForConnections</function> function to listen for new connections. Afterwards, each time a client connects, the session manager should call <function>IceAcceptConnection</function></para> -<para>See <link linkend='authentication_of_clients'>section 9, “Authentication of Clients,”</link> for more details on authentication (including host based authentication). Also see the <emphasis remap='I'>Inter-Client Exchange Library</emphasis> standard for further details on listening for and accepting ICE connections.</para> +<para>See <link linkend='authentication_of_clients'>section 9, “Authentication of Clients,”</link> for more details on authentication (including host based authentication). Also see the <citetitle pubwork='article'>Inter-Client Exchange Library</citetitle> standard for further details on listening for and accepting ICE connections.</para> <para>Each time a new client connects to the session manager, the <function>SmsNewClientProc</function> callback is invoked. The session manager obtains a new opaque connection object that it should use for all future interaction with the client. At this time, the session manager must also register a set of callbacks to respond to the different messages that the client might send.</para> @@ -1012,23 +1012,23 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>A new opaque connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>mask_ret</emphasis></term> + <term><parameter>mask_ret</parameter></term> <listitem><para>On return, indicates which callbacks were set by the session manager.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>callbacks_ret</emphasis></term> + <term><parameter>callbacks_ret</parameter></term> <listitem><para>On return, contains the callbacks registered by the session manager.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>failure_reason_ret</emphasis></term> + <term><parameter>failure_reason_ret</parameter></term> <listitem><para>Failure reason returned.</para></listitem> </varlistentry> </variablelist> @@ -1125,15 +1125,15 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>previous_id</emphasis></term> + <term><parameter>previous_id</parameter></term> <listitem><para>The client ID from the previous session.</para></listitem> </varlistentry> </variablelist> @@ -1164,15 +1164,15 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>dialog_type</emphasis></term> + <term><parameter>dialog_type</parameter></term> <listitem><para>The type of dialog the client wishes to present to the user.</para></listitem> </varlistentry> </variablelist> @@ -1200,15 +1200,15 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>cancel_shutdown</emphasis></term> + <term><parameter>cancel_shutdown</parameter></term> <listitem><para>Specifies if the user requests that the entire shutdown be cancelled.</para></listitem> </varlistentry> </variablelist> @@ -1239,31 +1239,31 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>save_type</emphasis></term> + <term><parameter>save_type</parameter></term> <listitem><para>Specifies the type of information that should be saved.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>shutdown</emphasis></term> + <term><parameter>shutdown</parameter></term> <listitem><para>Specifies if a shutdown is taking place.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>interact_style</emphasis></term> + <term><parameter>interact_style</parameter></term> <listitem><para>The type of interaction allowed with the user.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>fast</emphasis></term> + <term><parameter>fast</parameter></term> <listitem><para>If <function>True</function> the client should save its state as quickly as possible.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>global</emphasis></term> + <term><parameter>global</parameter></term> <listitem><para>Controls who gets the “Save Yourself.”</para></listitem> </varlistentry> </variablelist> @@ -1288,11 +1288,11 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> </variablelist> @@ -1316,15 +1316,15 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>success</emphasis></term> + <term><parameter>success</parameter></term> <listitem><para>If <function>True</function> the Save Yourself operation was completed successfully.</para></listitem> </varlistentry> </variablelist> @@ -1348,19 +1348,19 @@ If the client is first joining the session, previous_id will be NULL.</para> </funcsynopsis> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>count</emphasis></term> + <term><parameter>count</parameter></term> <listitem><para>The number of reason messages.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>reason_msgs</emphasis></term> + <term><parameter>reason_msgs</parameter></term> <listitem><para>The reasons for closing the connection.</para></listitem> </varlistentry> </variablelist> @@ -1386,19 +1386,19 @@ If the client is first joining the session, previous_id will be NULL.</para> </funcsynopsis> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>num_props</emphasis></term> + <term><parameter>num_props</parameter></term> <listitem><para>The number of properties.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>props</emphasis></term> + <term><parameter>props</parameter></term> <listitem><para>The list of properties to set.</para></listitem> </varlistentry> </variablelist> @@ -1427,19 +1427,19 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>num_props</emphasis></term> + <term><parameter>num_props</parameter></term> <listitem><para>The number of properties.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>prop_names</emphasis></term> + <term><parameter>prop_names</parameter></term> <listitem><para>The list of properties to delete.</para></listitem> </varlistentry> </variablelist> @@ -1462,11 +1462,11 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>manager_data</emphasis></term> + <term><parameter>manager_data</parameter></term> <listitem><para>Manager data specified when the callback was registered.</para></listitem> </varlistentry> </variablelist> @@ -1489,11 +1489,11 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_id</emphasis></term> + <term><parameter>client_id</parameter></term> <listitem><para>A null-terminated string representing a unique client ID.</para></listitem> </varlistentry> </variablelist> @@ -1517,7 +1517,7 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> </variablelist> @@ -1543,23 +1543,23 @@ If the client is first joining the session, previous_id will be NULL.</para> </funcsynopsis> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>save_type</emphasis></term> + <term><parameter>save_type</parameter></term> <listitem><para>Specifies the type of information that should be saved.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>shutdown</emphasis></term> + <term><parameter>shutdown</parameter></term> <listitem><para>Specifies if a shutdown is taking place.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>interact_style</emphasis></term> + <term><parameter>interact_style</parameter></term> <listitem><para>The type of interaction allowed with the user.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>fast</emphasis></term> + <term><parameter>fast</parameter></term> <listitem><para>If <function>True</function> the client should save its state as quickly as possible.</para></listitem> </varlistentry> </variablelist> @@ -1590,7 +1590,7 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> </variablelist> @@ -1612,7 +1612,7 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> </variablelist> @@ -1636,7 +1636,7 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> </variablelist> @@ -1658,7 +1658,7 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> </variablelist> @@ -1680,7 +1680,7 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> </variablelist> @@ -1705,15 +1705,15 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>num_props</emphasis></term> + <term><parameter>num_props</parameter></term> <listitem><para>The number of properties.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>props</emphasis></term> + <term><parameter>props</parameter></term> <listitem><para>The list of properties to return to the client.</para></listitem> </varlistentry> </variablelist> @@ -1738,15 +1738,15 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>ice_conn</emphasis></term> + <term><parameter>ice_conn</parameter></term> <listitem><para>A valid ICE connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>ping_reply_proc</emphasis></term> + <term><parameter>ping_reply_proc</parameter></term> <listitem><para>The callback to invoke when the Ping reply arrives.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>This pointer will be passed to the <function>IcePingReplyProc</function> callback.</para></listitem> </varlistentry> </variablelist> @@ -1764,11 +1764,11 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>ice_conn</emphasis></term> + <term><parameter>ice_conn</parameter></term> <listitem><para>A valid ICE connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>client_data</emphasis></term> + <term><parameter>client_data</parameter></term> <listitem><para>The client data specified in the call to <function>IcePing</function></para></listitem> </varlistentry> </variablelist> @@ -1788,7 +1788,7 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> </variablelist> @@ -1835,7 +1835,7 @@ If the client is first joining the session, previous_id will be NULL.</para> </funcprototype> </funcsynopsis> -<para>The string returned is of the form <emphasis remap='I'>protocol</emphasis>/<emphasis remap='I'>hostname</emphasis>, where <emphasis remap='I'>protocol</emphasis> is one of {tcp, decnet, local}. You should call <function>free</function> on the string returned when it is no longer needed.</para> +<para>The string returned is of the form <parameter>protocol</parameter><literal>/</literal><parameter>hostname</parameter>, where <parameter>protocol</parameter> is one of {<literal>tcp</literal>, <literal>decnet</literal>, <literal>local</literal>}. You should call <function>free</function> on the string returned when it is no longer needed.</para> <funcsynopsis> <funcprototype> @@ -1844,7 +1844,7 @@ If the client is first joining the session, previous_id will be NULL.</para> </funcprototype> </funcsynopsis> -<para><function>SmsGetIceConnection</function> returns the ICE connection object associated with this session management connection object. The ICE connection object can be used to get some additional information about the connection. Some of the more useful functions which can be used on the IceConn are <function>IceConnectionNumber</function> and <function>IceLastSequenceNumber</function> For further information, see the <emphasis remap='I'>Inter-Client Exchange Library</emphasis> standard.</para> +<para><function>SmsGetIceConnection</function> returns the ICE connection object associated with this session management connection object. The ICE connection object can be used to get some additional information about the connection. Some of the more useful functions which can be used on the IceConn are <function>IceConnectionNumber</function> and <function>IceLastSequenceNumber</function> For further information, see the <citetitle pubwork='article'>Inter-Client Exchange Library</citetitle> standard.</para> </sect1> <sect1 id='error_handling2'> @@ -1877,36 +1877,36 @@ If the client is first joining the session, previous_id will be NULL.</para> <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>sms_conn</emphasis></term> + <term><parameter>sms_conn</parameter></term> <listitem><para>The session management connection object.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>swap</emphasis></term> + <term><parameter>swap</parameter></term> <listitem><para>A flag which indicates if the specified values need byte swapping.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>offending_minor_opcode</emphasis></term> + <term><parameter>offending_minor_opcode</parameter></term> <listitem><para>The minor opcode of the offending message.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>offending_sequence_num</emphasis></term> + <term><parameter>offending_sequence_num</parameter></term> <listitem><para>The sequence number of the offending message.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>error_class</emphasis></term> + <term><parameter>error_class</parameter></term> <listitem><para>The error class of the offending message.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>severity</emphasis></term> + <term><parameter>severity</parameter></term> <listitem><para><function>IceCanContinue</function><function>IceFatalToProtocol</function> or <function>IceFatalToConnection</function></para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>values</emphasis></term> + <term><parameter>values</parameter></term> <listitem><para>Any additional error values specific to the minor opcode and class.</para></listitem> </varlistentry> </variablelist> -<para>Note that this error handler is invoked for protocol related errors. To install an error handler to be invoked when an IO error occurs, use <function>IceSetIOErrorHandler</function> For further information, see the <emphasis remap='I'>Inter-Client Exchange Library</emphasis> standard.</para> +<para>Note that this error handler is invoked for protocol related errors. To install an error handler to be invoked when an IO error occurs, use <function>IceSetIOErrorHandler</function> For further information, see the <citetitle pubwork='article'>Inter-Client Exchange Library</citetitle> standard.</para> </sect1> </chapter> @@ -1943,7 +1943,7 @@ typedef struct { <row> <entry align='left'>Name</entry> <entry align='left'>Type</entry> - <entry align='left'>POSIX Type</entry> + <entry align='left'><acronym>POSIX</acronym> Type</entry> <entry align='center'>Required</entry> </row> </thead> @@ -2091,7 +2091,7 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>prop</emphasis></term> + <term><parameter>prop</parameter></term> <listitem><para>The property to free.</para></listitem> </varlistentry> </variablelist> @@ -2108,11 +2108,11 @@ typedef struct { <variablelist remap='IP'> <varlistentry> - <term><emphasis remap='I'>count</emphasis></term> + <term><parameter>count</parameter></term> <listitem><para>The number of reason strings.</para></listitem> </varlistentry> <varlistentry> - <term><emphasis remap='I'>reasons</emphasis></term> + <term><parameter>reasons</parameter></term> <listitem><para>The list of reason strings to free.</para></listitem> </varlistentry> </variablelist> @@ -2129,13 +2129,13 @@ typedef struct { </itemizedlist> <para>The authentication methods that are available are implementation-dependent -(that is., dependent on the ICElib and SMlib implementations in use). For further information, see the <emphasis remap='I'>Inter-Client Exchange Library</emphasis> standard.</para> +(that is., dependent on the ICElib and SMlib implementations in use). For further information, see the <citetitle pubwork='article'>Inter-Client Exchange Library</citetitle> standard.</para> </chapter> <chapter id='working_in_a_multithreaded_environment'> <title>Working in a Multi-Threaded Environment</title> -<para>To declare that multiple threads in an application will be using SMlib (or any other library layered on top of ICElib), you should call <function>IceInitThreads</function> For further information, see the <emphasis remap='I'>Inter-Client Exchange Library</emphasis> standard.</para> +<para>To declare that multiple threads in an application will be using SMlib (or any other library layered on top of ICElib), you should call <function>IceInitThreads</function> For further information, see the <citetitle pubwork='article'>Inter-Client Exchange Library</citetitle> standard.</para> </chapter> <chapter id='acknowledgements'> |