/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSProcessInfo.html is in gnustep-base-doc 1.25.1-2ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>NSProcessInfo class reference</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSProcessInfo">NSProcessInfo class reference</a></h1>
<h3>Authors</h3>
<dl>
<dt>Georg Tuparev (<a href="mailto:Tuparev@EMBL-Heidelberg.de"><code>Tuparev@EMBL-Heidelberg.de</code></a>)</dt>
<dd>
</dd>
<dt>Richard Frith-Macdonald (<a href="mailto:rfm@gnu.org"><code>rfm@gnu.org</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 1995-2017 Free Software Foundation, Inc.</p>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Software documentation for the NSProcessInfo class</a>
</li>
<li>
<a href="#002000000000">Software documentation for the NSProcessInfo(GNUstep)
category</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">
Software documentation for the NSProcessInfo class
</a></h1>
<h2><a name="class$NSProcessInfo">NSProcessInfo</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSProcessInfo.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Instances of this class encapsulate information on
the current process. For example, you can get the
arguments, environment variables, host name, or
process name. There is only one instance per process,
for obvious reasons, and it may be obtained through the
<a rel="gsdoc" href="#method$NSProcessInfo+processInfo">
+processInfo
</a>
method.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo(GNUstep)+initializeWithArguments$count$environment$">+initializeWithArguments:count:environment:</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo(GNUstep)-setLogFile$">-setLogFile:</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo+processInfo">+processInfo</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-activeProcessorCount">-activeProcessorCount</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-arguments">-arguments</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-beginActivityWithOptions$reason$">-beginActivityWithOptions:reason:</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-disableSuddenTermination">-disableSuddenTermination</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-enableSuddenTermination">-enableSuddenTermination</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-endActivity$">-endActivity:</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-environment">-environment</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-globallyUniqueString">-globallyUniqueString</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-hostName">-hostName</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-operatingSystem">-operatingSystem</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-operatingSystemName">-operatingSystemName</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-operatingSystemVersionString">-operatingSystemVersionString</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-performActivityWithOptions$reason$usingBlock$">-performActivityWithOptions:reason:usingBlock:</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-performExpiringActivityWithReason$usingBlock$">-performExpiringActivityWithReason:usingBlock:</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-physicalMemory">-physicalMemory</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-processIdentifier">-processIdentifier</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-processName">-processName</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-processorCount">-processorCount</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-setProcessName$">-setProcessName:</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo-systemUptime">-systemUptime</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSProcessInfo+processInfo">processInfo </a></h3>
+ (<a rel="gsdoc" href="#class$NSProcessInfo">NSProcessInfo</a>*) <b>processInfo</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the shared NSProcessInfo object for the
current process.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-activeProcessorCount">activeProcessorCount </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>activeProcessorCount</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
<div class="desc">
Not implemented
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-arguments">arguments </a></h3>
- (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*) <b>arguments</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an array containing the arguments supplied
to start this process. <br /> NB. In GNUstep, any
arguments of the form --GNU-Debug=... are
<em>not</em> included in this array... they are part
of the debug mechanism, and are hidden so that setting
debug variables will not effect the normal operation
of the program. <br /> Please note, the special
<code>--GNU-Debug=...</code> syntax differs from
that which is used to specify values for the
<a rel="gsdoc" href="NSUserDefaults.html#class$NSUserDefaults">NSUserDefaults</a>
system. <br /> User defaults are set on the
command line by specifying the default name (with
a leading hyphen) as one argument, and the default
value as the following argument. The arguments used
to set user defaults are present in the array returned
by this method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-beginActivityWithOptions$reason$">beginActivityWithOptions: reason: </a></h3>
- (id) <b>beginActivityWithOptions:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSActivityOptions">NSActivityOptions</a>)options<b> reason:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)reason;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-disableSuddenTermination">disableSuddenTermination </a></h3>
- (void) <b>disableSuddenTermination</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-enableSuddenTermination">enableSuddenTermination </a></h3>
- (void) <b>enableSuddenTermination</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-endActivity$">endActivity: </a></h3>
- (void) <b>endActivity:</b> (id<<a rel="gsdoc" href="NSObject.html#protocol$(NSObject)">NSObject</a>>)activity;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-environment">environment </a></h3>
- (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*) <b>environment</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns a dictionary giving the environment
variables which were provided for the process to
use.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-globallyUniqueString">globallyUniqueString </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>globallyUniqueString</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns a string which may be used as a globally
unique identifier. <br /> The string contains the
host name, the process ID, a timestamp and a counter.
<br /> The first three values identify the process
in which the string is generated, while the fourth
ensures that multiple strings generated within the
same process are unique.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-hostName">hostName </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>hostName</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the name of the machine on which this
process is running.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-operatingSystem">operatingSystem </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>operatingSystem</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Return a number representing the operating system
type. <br /> The known types are listed in the header
file, but not all of the listed types are actually
implemented... some are present for MacOS-X
compatibility only. <br />
<ul>
<li>
NSWindowsNTOperatingSystem -
used for Windows NT, and later
</li>
<li>
NSWindows95OperatingSystem -
probably never to be implemented
</li>
<li>
NSSolarisOperatingSystem -
used for Sun Solaris
</li>
<li>
NSHPUXOperatingSystem - used for
HP/UX
</li>
<li>
NSMACHOperatingSystem - MacOSX
and perhaps Hurd in future?
</li>
<li>
NSSunOSOperatingSystem - Used
for Sun Sun/OS
</li>
<li>
NSOSF1OperatingSystem - Used for
OSF/1 (probably obsolete)
</li>
<li>
GSGNULinuxOperatingSystem -
the GNUstep 'standard'
</li>
<li>
GSBSDOperatingSystem - BSD derived
operating systems
</li>
<li>
GSBeperatingSystem - Used for Be-OS
(probably obsolete)
</li>
<li>
GSCygwinOperatingSystem -
cygwin unix-like environment
</li>
</ul>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-operatingSystemName">operatingSystemName </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>operatingSystemName</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Return a human readable string representing the
operating system type. <br /> The supported types
are -
<ul>
<li>
NSWindowsNTOperatingSystem -
used for Windows NT, and later
</li>
<li>
NSWindows95OperatingSystem -
probably never to be implemented
</li>
<li>
NSSolarisOperatingSystem -
used for Sun Solaris
</li>
<li>
NSHPUXOperatingSystem - used for
HP/UX
</li>
<li>
NSMACHOperatingSystem - MacOSX
and perhaps Hurd in future?
</li>
<li>
NSSunOSOperatingSystem - Used
for Sun Sun/OS
</li>
<li>
NSOSF1OperatingSystem - Used for
OSF/1 (probably obsolete)
</li>
<li>
GSGNULinuxOperatingSystem -
the GNUstep 'standard'
</li>
<li>
GSBSDOperatingSystem - BSD derived
operating systems
</li>
<li>
GSBeperatingSystem - Used for Be-OS
(probably obsolete)
</li>
<li>
GSCygwinOperatingSystem -
cygwin unix-like environment
</li>
</ul>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-operatingSystemVersionString">operatingSystemVersionString </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>operatingSystemVersionString</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.2.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-performActivityWithOptions$reason$usingBlock$">performActivityWithOptions: reason: usingBlock: </a></h3>
- (void) <b>performActivityWithOptions:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSActivityOptions">NSActivityOptions</a>)options<b> reason:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)reason<b> usingBlock:</b> (GSPerformActivityBlock)block;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-performExpiringActivityWithReason$usingBlock$">performExpiringActivityWithReason: usingBlock: </a></h3>
- (void) <b>performExpiringActivityWithReason:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)reason<b> usingBlock:</b> (GSPerformExpiringActivityBlock)block;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-physicalMemory">physicalMemory </a></h3>
- (unsigned long long) <b>physicalMemory</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
<div class="desc">
Not implemented
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-processIdentifier">processIdentifier </a></h3>
- (int) <b>processIdentifier</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Returns the process identifier number which
uniquely identifies this process on this machine.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-processName">processName </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>processName</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the process name for this process. This may
have been set using the
<a rel="gsdoc" href="#method$NSProcessInfo-setProcessName$">
-setProcessName:
</a>
method, or may be the default process name (the
file name of the binary being executed).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-processorCount">processorCount </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>processorCount</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
<div class="desc">
Not implemented
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-setProcessName$">setProcessName: </a></h3>
- (void) <b>setProcessName:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)newName;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Change the name of the current process to
<var>newName</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo-systemUptime">systemUptime </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>systemUptime</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="002000000000">
Software documentation for the NSProcessInfo(GNUstep)
category
</a></h1>
<h2><a rel="gsdoc" href="#class$NSProcessInfo">NSProcessInfo</a>(<a name="category$NSProcessInfo(GNUstep)">GNUstep</a>)</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSProcessInfo.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Base<br />
Likely to be changed/moved/removed at 1.17.0</div>
<br />
<div class="desc">
Provides GNUstep-specific methods for controlled
debug logging (a GNUstep facility) and an
internal/developer-related method.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo(GNUstep)+initializeWithArguments$count$environment$">+initializeWithArguments:count:environment:</a></li>
<li><a rel="gsdoc" href="NSProcessInfo.html#method$NSProcessInfo(GNUstep)-setLogFile$">-setLogFile:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSProcessInfo(GNUstep)+initializeWithArguments$count$environment$">initializeWithArguments: count: environment: </a></h3>
+ (void) <b>initializeWithArguments:</b> (char**)argv<b> count:</b> (int)argc<b> environment:</b> (char**)env;<br />
<div class="availability">
<b>Availability:</b> Base<br />
Likely to be changed/moved/removed at 1.17.0</div>
<br />
<div class="desc">
Obsolete... the
<a rel="gsdoc" href="Functions.html#function$GSInitializeProcess">
GSInitializeProcess()
</a>
function has the same effect and can be called
more easily from other languages (particularly C).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSProcessInfo(GNUstep)-setLogFile$">setLogFile: </a></h3>
- (BOOL) <b>setLogFile:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)path;<br />
<div class="availability">
<b>Availability:</b> Base<br />
Likely to be changed/moved/removed at 1.17.0</div>
<br />
<div class="desc">
Set the file to which NSLog output should be directed.
<br /> Returns <code>YES</code> on success,
<code>NO</code> on failure. <br /> By default
logging goes to standard error.
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
|