This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

CHUDREMOTECTRL(1)                                                                          CHUDREMOTECTRL(1)



NAME
       chudRemoteCtrl  -  start  or stop the collection of performance monitor data in a performance monitor
       remote server application.

SYNOPSIS
       chudRemoteCtrl [ -m ] [ executable [args... ] ]

       chudRemoteCtrl -s label

       chudRemoteCtrl -e

       chudRemoteCtrl -k PID


DESCRIPTION
       chudRemoteCtrl is a command line tool that allows for the collection of performance data by any
       active performance monitor remote server application. There are currently two CHUD Tools that can be
       put in remote performance monitor server mode: MONster, and Shark (as well as their command line
       counterparts). Typically, chudRemoteCtrl is invoked on the command line or in a shell script, fol-lowed followed
       lowed by the path to an executable to be measured and its arguments.  chudRemoteCtrl issues a chud-StartRemotePerfMonitor chudStartRemotePerfMonitor
       StartRemotePerfMonitor message immediately after launching the specified target program. When the
       launched program terminates, chudRemoteCtrl issues a chudStopRemotePerfMonitor message, and then
       exits. When the '-s', '-e' or '-k PID' options are used, no program is launched.


OPTIONS
       -r     seconds: If the 'chudStartRemotePerfMonitor' message fails to either acquire or start the
              remote monitoring service, then keep trying to start again, until the specified number of sec-onds seconds
              onds has elapsed.  The same thing is true of the '-e' option. If there is a '-r <seconds>'
              argument on the command line, and a failure occurs trying to stop the remote profiling pro-gram, program,
              gram, the stop message will be sent again until the retry time limit is reached.

       -s     label: Issue a chudStartRemotePerfMonitor message with the specified label and exit. A 'label'
              is a string of up to 32 characters.

       -e     Issue a chudStopRemotePerfMonitor message and exit.

       -q     silence some of the non-essential warning and error output.

       -kPID  Send a UNIX signal (SIGUSR1 or SIGUSR2) to the specified process-id. For example, if command-line commandline
              line tool, 'monster' is running as PID 4267, using '-k 4267' along with a '-e' , will send a
              SIGUSR2 to the 'monster' command-line tool and 'monster' will stop performance data sampling.
              A 'start' example:               % chudRemoteCtrl -s session_42 -k 4267.  And a 'stop' exam-ple: example:
              ple:               % chudRemoteCtrl -e -k 4267.  The command-line CHUD tools 'shark' and 'mon-ster' 'monster'
              ster' respond to UNIX signals and toggle performance monitor sampling.

       -m     Set the performance monitor mark bit in the main thread of the launched child process.


DIAGNOSTICS
       chudRemoteCtrl returns a zero (0) upon success and a non-zero value on failure.


BUGS
       Please send your comments, suggestions and bug reports to: perftools-feedback@group.apple.com


SEE ALSO
       monster(1), shark(1)



CHUD                                           6 October 2003                              CHUDREMOTECTRL(1)