ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/Deliantra-Client/pod/command_help.pod
(Generate patch)

Comparing deliantra/Deliantra-Client/pod/command_help.pod (file contents):
Revision 1.9 by root, Mon Dec 11 02:43:21 2006 UTC vs.
Revision 1.14 by root, Sun Mar 18 03:03:36 2007 UTC

1=begin comment
2
3***
4*** WARNING:
5*** This file resides in both CFPlus/pod/ and server/pod/
6*** Only ever edit the version in CFPlus/pod/ and run
7*** ./copy_pod inside server/pod/ to update that copy.
8***
9
10=end
11
12=head1 Crossfire+ Command ListingX<command> 1=head1 Crossfire+ Command ListingX<command>
13 2
14=head2 accept-invitation 3=head2 accept-invitation
15 4
16Accepts an invitation previously issued by another player using the invite 5Accepts an invitation previously issued by another player using the invite
454The rest is information the mapper may or may not provide. Often, this is 443The rest is information the mapper may or may not provide. Often, this is
455the mapper's name, email and map creation date as this example shows. 444the mapper's name, email and map creation date as this example shows.
456 445
457=head2 maps 446=head2 maps
458 447
459Shows a list of maps that are currently being visited or have been visited. 448[crossfire+]
460The different fields are Path, Pl, PlM, IM, TO, Dif and Reset. They mean:
461 449
462Path: The last part of the map path 450 maps <mapname>
463Pl: Players on the map. 451
464PlM: Players on the map recounted (should be the same as Pl). 452Shows a list of maps matching the regex <mapname> that are currently being
465IM: In memory means whether the map is: 1) in memory, 2) swapped to disk, 453known to the server. The different fields are Pl, I, Svd, Reset and Path:
4663) currently loading or 4) currently saving. 454
467TO: Timeout, when the map is swapped to disk. 455=over 4
468Dif: Map difficulty. 456
469Reset: Real server time when the map is going to reset. 457=item Pl: the number of players on that map currently.
458
459=item I: B<I>n memory, B<S>wapped out or B<L>oading.
460
461The server keeps maps in memory only for a short time (by default about
46240 seconds). After that time, it saves them to disk. As the server loads
463most maps in the background it is possible that you can see a map that is
464currently being loaded, but thats rare, as loading a map is fast.
465
466=item Svd: the amount of seconds the map was last saved (++ means >99).
467
468The server by default tries to save each map at least every 20 seconds if
469it changed, so in case of a disastrous crash (one where the server cannot
470emergency save), at most 20 seconds of gameplay are lost.
471
472=item Reset: the minimum number of seconds the map will stay as is (will not reset).
473
474Most maps will not reset as long as players are on it, and usually the
475reset counter only starts going down when all players left the map.
476
477=item Path: the name that uniquely identifies the map, can be used for goto etc.
478
479=back
480
470 481
471=head2 mark 482=head2 mark
472 483
473B<mark> is used to mark items for items that apply other items. Examples of 484B<mark> is used to mark items for items that apply other items. Examples of
474these are flint & steel marked for apply torches, a weapon marked for 485these are flint & steel marked for apply torches, a weapon marked for
563'help traps for help with finding 574'help traps for help with finding
564and disarming traps 575and disarming traps
565 576
566=head2 output-count 577=head2 output-count
567 578
568output-sync controls how often information is sent to the screen. Each 579 output-count [lines]
569buffer has its own time value, and will be flushed independantly. The
570default value is 16 ticks (about 2 seconds).
571 580
572output-count sets after how many messages of the same type, they are 581output-count sets after how many messages of the same type, they are
573then printed out. If the value was 10, then after killing ten orcs, the 582then printed out. If the value was 10, then after killing ten orcs, the
574message '10 times you kill orc' would be printed out. The default value is 583message '10 times you kill orc' would be printed out. The default value is
5751 - this means that all messages get printed out as they are requested - 5841 - this means that all messages get printed out as they are requested -
576buffering is disabled in this regard. 585buffering is disabled in this regard.
577 586
578See also L<output-sync>.
579
580=head2 output-sync
581
582output-sync controls how often information is sent to the screen. Each 587output-sync controls how often information is sent to the screen. Each
583buffer has its own time value, and will be flushed independantly. The 588buffer has its own time value, and will be flushed independantly. The
584default value is 16 ticks (about 2 seconds). 589default value is usually less than a second.
590
591See also L<output-sync>.
592
593=head2 output-rate [bytes per second]
594
595Show the current setting of the output-rate, or set it to the provided
596value. The server will try not to send (much) more than this many bytes
597per second to your client. If the rate is exceeded, the server tries to
598hold back less important information (such as new images), to increase
599responsiveness. The server-side default is usually quite high, around
600100000, so if you have a slow link and want to be able to control your
601character even when downloading faces, set this to a lower value, such as
6027000 (for ISDN).
603
604=head2 output-sync
605
606 output-sync [seconds]
607
608output-sync controls how often information is sent to the screen. Each
609buffer has its own time value, and will be flushed independantly. The
610default value is usually less than a second.
585 611
586output-count sets after how many messages of the same type, they are 612output-count sets after how many messages of the same type, they are
587then printed out. If the value was 10, then after killing ten orcs, the 613then printed out. If the value was 10, then after killing ten orcs, the
588message '10 times you kill orc' would be printed out. The default value is 614message '10 times you kill orc' would be printed out. The default value is
5891 - this means that all messages get printed out as they are requested - 6151 - this means that all messages get printed out as they are requested -
757 783
758If either of the names contain spaces, you have to use the C<">-form, 784If either of the names contain spaces, you have to use the C<">-form,
759otherwise you can just write the name as-is. If you omit the old name, the 785otherwise you can just write the name as-is. If you omit the old name, the
760marked item will be used instead. 786marked item will be used instead.
761 787
762If the new name is empty (i.e. C<"">), then the custom name will be 788If the new name is empty (i.e. C<"">), then the original (unrenamed) name
763removed from the item. 789will be restored.
764 790
765Note: maximum allowed name length is 127 characters. 791Note: maximum allowed name length is 127 characters.
766 792
767=head2 reply 793=head2 reply
768 794

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines