diff --git a/reference/fam/functions/fam-cancel-monitor.xml b/reference/fam/functions/fam-cancel-monitor.xml index 5312c55ceb..f9a3655cf6 100644 --- a/reference/fam/functions/fam-cancel-monitor.xml +++ b/reference/fam/functions/fam-cancel-monitor.xml @@ -1,31 +1,31 @@ - - - - fam_cancel_monitor - Terminate monitoring - - - &reftitle.description; - - boolfam_cancel_monitor - resourcefam - resourcefam_monitor - - - fam_cancel_monitor terminates monitoring on - a resource previously requested using one of the - fam_monitor_ functions. - In addition an FAMAcknowledge event occurs. - - - See also fam_monitor_file, - fam_monitor_directory, - fam_monitor_collection, and - fam_suspend_monitor - - - + + + + fam_cancel_monitor + Terminate monitoring + + + &reftitle.description; + + boolfam_cancel_monitor + resourcefam + resourcefam_monitor + + + fam_cancel_monitor terminates monitoring on + a resource previously requested using one of the + fam_monitor_ functions. + In addition an FAMAcknowledge event occurs. + + + See also fam_monitor_file, + fam_monitor_directory, + fam_monitor_collection, and + fam_suspend_monitor + + + - - - fam_close - Close FAM connection - - - &reftitle.description; - - voidfam_close - resourcefam - - - fam_close closes a connection to the FAM service - previously opened using fam_open. - - - + + + + fam_close + Close FAM connection + + + &reftitle.description; + + voidfam_close + resourcefam + + + fam_close closes a connection to the FAM service + previously opened using fam_open. + + + - - - fam_monitor_collection - Monitor a collection of files in a directory for changes - - - &reftitle.description; - - resourcefam_monitor_collection - resourcefam - stringdirname - intdepth - stringmask - - - fam_monitor_collection requests monitoring for a collection of - files within a directory. The actual files to be monitored are specified by a - directory path in dirname, the maximum search - depth starting from this directory and a shell pattern - mask restricting the file names to look for. - - - - A FAM event will be generated whenever the status of the files change. - The possible event codes are described in detail in the - constants part of this section. - - - See also fam_monitor_file, - fam_monitor_directory, - fam_cancel_monitor, - fam_suspend_monitor, and - fam_resume_monitor. - - - + + + + fam_monitor_collection + Monitor a collection of files in a directory for changes + + + &reftitle.description; + + resourcefam_monitor_collection + resourcefam + stringdirname + intdepth + stringmask + + + fam_monitor_collection requests monitoring for a collection of + files within a directory. The actual files to be monitored are specified by a + directory path in dirname, the maximum search + depth starting from this directory and a shell pattern + mask restricting the file names to look for. + + + + A FAM event will be generated whenever the status of the files change. + The possible event codes are described in detail in the + constants part of this section. + + + See also fam_monitor_file, + fam_monitor_directory, + fam_cancel_monitor, + fam_suspend_monitor, and + fam_resume_monitor. + + + - - - fam_monitor_directory - Monitor a directory for changes - - - &reftitle.description; - - resourcefam_monitor_directory - resourcefam - stringdirname - - - fam_monitor_directory requests monitoring for a directory - and all contained files. A FAM event will be generated whenever the status - of the directory (i.e. the result of function stat on - that directory) or its content (i.e. the results of readdir) - change. - - - - The possible event codes are described in detail in the - constants part of this section. - - - See also fam_monitor_file, - fam_monitor_collection, - fam_cancel_monitor, - fam_suspend_monitor, and - fam_resume_monitor. - - - + + + + fam_monitor_directory + Monitor a directory for changes + + + &reftitle.description; + + resourcefam_monitor_directory + resourcefam + stringdirname + + + fam_monitor_directory requests monitoring for a directory + and all contained files. A FAM event will be generated whenever the status + of the directory (i.e. the result of function stat on + that directory) or its content (i.e. the results of readdir) + change. + + + + The possible event codes are described in detail in the + constants part of this section. + + + See also fam_monitor_file, + fam_monitor_collection, + fam_cancel_monitor, + fam_suspend_monitor, and + fam_resume_monitor. + + + - - - fam_monitor_file - Monitor a regular file for changes - - - &reftitle.description; - - resourcefam_monitor_file - resourcefam - stringfilename - - - fam_monitor_file requests monitoring for a single - file. A FAM event will be generated whenever the file status - (i.e. the result of function stat on that file) - changes. - - - The possible event codes are described in detail in the - constants part of this section. - - - See also fam_monitor_directory, - fam_monitor_collection, - fam_cancel_monitor, - fam_suspend_monitor, and - fam_resume_monitor. - - - + + + + fam_monitor_file + Monitor a regular file for changes + + + &reftitle.description; + + resourcefam_monitor_file + resourcefam + stringfilename + + + fam_monitor_file requests monitoring for a single + file. A FAM event will be generated whenever the file status + (i.e. the result of function stat on that file) + changes. + + + The possible event codes are described in detail in the + constants part of this section. + + + See also fam_monitor_directory, + fam_monitor_collection, + fam_cancel_monitor, + fam_suspend_monitor, and + fam_resume_monitor. + + + - - - fam_next_event - Get next pending FAM event - - - &reftitle.description; - - arrayfam_next_event - resourcefam - - - fam_next_event returns the next pending FAM - event. The function will block until an event is available which can - be checked for using fam_pending. - - - fam_next_event will return an array that contains - a FAM event code in element 'code', the path of the - file this event applies to in element 'filename' and - optionally a hostname in element 'hostname'. - - - The possible event codes are described in detail in the - constants part of this section. - - - See also fam_pending. - - - + + + + fam_next_event + Get next pending FAM event + + + &reftitle.description; + + arrayfam_next_event + resourcefam + + + fam_next_event returns the next pending FAM + event. The function will block until an event is available which can + be checked for using fam_pending. + + + fam_next_event will return an array that contains + a FAM event code in element 'code', the path of the + file this event applies to in element 'filename' and + optionally a hostname in element 'hostname'. + + + The possible event codes are described in detail in the + constants part of this section. + + + See also fam_pending. + + + - - - fam_open - Open connection to FAM daemon - - - &reftitle.description; - - resourcefam_open - stringappname - - - fam_open opens a connection to the FAM service - daemon. The optional parameter appname should - be set to a string identifying the application for logging reasons. - - - See also fam_close. - - - + + + + fam_open + Open connection to FAM daemon + + + &reftitle.description; + + resourcefam_open + stringappname + + + fam_open opens a connection to the FAM service + daemon. The optional parameter appname should + be set to a string identifying the application for logging reasons. + + + See also fam_close. + + + - - - fam_pending - Check for pending FAM events - - - &reftitle.description; - - intfam_pending - resourcefam - - - fam_pending returns non-zero if events are - available to be fetched using fam_next_event. - - - See also fam_next_event. - - - + + + + fam_pending + Check for pending FAM events + + + &reftitle.description; + + intfam_pending + resourcefam + + + fam_pending returns non-zero if events are + available to be fetched using fam_next_event. + + + See also fam_next_event. + + + - - - fam_resume_monitor - Resume suspended monitoring - - - &reftitle.description; - - boolfam_resume_monitor - resourcefam - resourcefam_monitor - - - fam_resume_monitor resumes monitoring - of a resource previously suspend using fam_suspend_monitor. - - - See also fam_suspend_monitor. - - - + + + + fam_resume_monitor + Resume suspended monitoring + + + &reftitle.description; + + boolfam_resume_monitor + resourcefam + resourcefam_monitor + + + fam_resume_monitor resumes monitoring + of a resource previously suspend using fam_suspend_monitor. + + + See also fam_suspend_monitor. + + + - - - fam_suspend_monitor - Temporarily suspend monitoring - - - &reftitle.description; - - boolfam_suspend_monitor - resourcefam - resourcefam_monitor - - - fam_suspend_monitor temporarily suspend monitoring - of a resource previously requested using one of the - fam_monitor_ functions. - Monitoring can later be continued using fam_resume_monitor - without the need of requesting a complete new monitor. - - - See also fam_resume_monitor, and - fam_cancel_monitor. - - - + + + + fam_suspend_monitor + Temporarily suspend monitoring + + + &reftitle.description; + + boolfam_suspend_monitor + resourcefam + resourcefam_monitor + + + fam_suspend_monitor temporarily suspend monitoring + of a resource previously requested using one of the + fam_monitor_ functions. + Monitoring can later be continued using fam_resume_monitor + without the need of requesting a complete new monitor. + + + See also fam_resume_monitor, and + fam_cancel_monitor. + + +