diff options
Diffstat (limited to 'doxygen/man/man3/pirate8_Pirate.3')
| -rw-r--r-- | doxygen/man/man3/pirate8_Pirate.3 | 253 |
1 files changed, 0 insertions, 253 deletions
diff --git a/doxygen/man/man3/pirate8_Pirate.3 b/doxygen/man/man3/pirate8_Pirate.3 deleted file mode 100644 index 363a263..0000000 --- a/doxygen/man/man3/pirate8_Pirate.3 +++ /dev/null @@ -1,253 +0,0 @@ -.TH "pirate8::Pirate" 3 "Fri Sep 9 2011" "Cmd2" \" -*- nroff -*- -.ad l -.nh -.SH NAME -pirate8::Pirate \- -.SH SYNOPSIS -.br -.PP -.PP -Inherits \fBcmd2::Cmd\fP'\&. -.SS "Public Member Functions" - -.in +1c -.ti -1c -.RI "def \fBdefault\fP" -.br -.ti -1c -.RI "def \fBdo_drink\fP" -.br -.ti -1c -.RI "def \fBdo_loot\fP" -.br -.ti -1c -.RI "def \fBdo_quit\fP" -.br -.ti -1c -.RI "def \fBdo_sing\fP" -.br -.ti -1c -.RI "def \fBdo_yo\fP" -.br -.ti -1c -.RI "def \fBpostcmd\fP" -.br -.ti -1c -.RI "def \fBprecmd\fP" -.br -.in -1c -.SS "Public Attributes" - -.in +1c -.ti -1c -.RI "\fBinitial_gold\fP" -.br -.in -1c -.SS "Static Public Attributes" - -.in +1c -.ti -1c -.RI "string \fBaction\fP = 'store_true'" -.br -.ti -1c -.RI "\fBdefault_to_shell\fP = True" -.br -.ti -1c -.RI "int \fBgold\fP = 3" -.br -.ti -1c -.RI "string \fBhelp\fP = 'How often to chant 'ho''" -.br -.ti -1c -.RI "list \fBmultilineCommands\fP = ['sing']" -.br -.ti -1c -.RI "string \fBprompt\fP = 'arrr> '" -.br -.ti -1c -.RI "string \fBsettable\fP = '\fBsongcolor\fP Color to ``sing`` in (red/blue/green/cyan/magenta, bold, underline)'" -.br -.ti -1c -.RI "string \fBsongcolor\fP = 'blue'" -.br -.ti -1c -.RI "list \fBterminators\fP = \fBCmd\&.terminators\fP+['\&.\&.\&.']" -.br -.in -1c -.SH "Detailed Description" -.PP -Definition at line 4 of file pirate8\&.py'\&. -.SH "Member Function Documentation" -.PP -.SS "def pirate8::Pirate::default (self, line)" -.PP -Definition at line 7 of file pirate8\&.py'\&. -.PP -Referenced by cmd2::Cmd::_default()\&. -.PP -.nf -7 -8 def default(self, line): - print('What mean ye by '{0}'?'\&.format(line)) -.fi -.SS "def pirate8::Pirate::do_drink (self, arg)".PP -.nf -Drown your sorrrows in rrrum. - -drink [n] - drink [n] barrel[s] o' rum..fi -.PP - -.PP -Definition at line 12 of file pirate8\&.py'\&. -.PP -References pirate2::Pirate::gold, gold, pirate7::Pirate::gold, pirate6::Pirate::gold, pirate5::Pirate::gold, pirate4::Pirate::gold, and pirate3::Pirate::gold\&. -.PP -.nf -12 -13 def do_drink(self, arg): -14 '''Drown your sorrrows in rrrum\&. -15 -16 drink [n] - drink [n] barrel[s] o' rum\&.''' -17 try: -18 self\&.gold -= int(arg) -19 except: -20 if arg: -21 print('''What's '{0}'? I'll take rrrum\&.'''\&.format(arg)) - self\&.gold -= 1 -.fi -.SS "def pirate8::Pirate::do_loot (self, arg)" -.PP -Definition at line 9 of file pirate8\&.py'\&. -.PP -References pirate2::Pirate::gold, gold, pirate7::Pirate::gold, pirate6::Pirate::gold, pirate5::Pirate::gold, pirate4::Pirate::gold, and pirate3::Pirate::gold\&. -.PP -.nf -9 -10 def do_loot(self, arg): -11 'Seize booty from a passing ship\&.' - self\&.gold += 1 -.fi -.SS "def pirate8::Pirate::do_quit (self, arg)" -.PP -Reimplemented from \fBcmd2::Cmd\fP'\&. -.PP -Definition at line 33 of file pirate8\&.py'\&. -.PP -.nf -33 -34 def do_quit(self, arg): -35 print('Quiterrr!') - return True -.fi -.SS "def pirate8::Pirate::do_sing (self, arg)" -.PP -Definition at line 42 of file pirate8\&.py'\&. -.PP -References cmd2::Cmd::colorize(), cmd2::options(), songcolor, and pirate7::Pirate::songcolor\&. -.PP -.nf -42 -43 def do_sing(self, arg): - print(self\&.colorize(arg, self\&.songcolor)) -.fi -.SS "def pirate8::Pirate::do_yo (self, arg, opts)" -.PP -Definition at line 49 of file pirate8\&.py'\&. -.PP -.nf -49 -50 def do_yo(self, arg, opts): -51 chant = ['yo'] + ['ho'] * opts\&.ho -52 separator = ', ' if opts\&.commas else ' ' -53 chant = separator\&.join(chant) -54 print('{0} and a bottle of {1}' -55 \&.format(chant, arg)) - -.fi -.SS "def pirate8::Pirate::postcmd (self, stop, line)" -.PP -Definition at line 25 of file pirate8\&.py'\&. -.PP -References pirate2::Pirate::gold, pirate3::Pirate::gold, pirate5::Pirate::gold, pirate6::Pirate::gold, pirate4::Pirate::gold, pirate7::Pirate::gold, gold, pirate3::Pirate::initial_gold, pirate4::Pirate::initial_gold, pirate5::Pirate::initial_gold, pirate7::Pirate::initial_gold, initial_gold, and pirate6::Pirate::initial_gold\&. -.PP -Referenced by cmd2::Cmd::onecmd_plus_hooks()\&. -.PP -.nf -25 -26 def postcmd(self, stop, line): -27 if self\&.gold != self\&.initial_gold: -28 print('Now we gots {0} doubloons' -29 \&.format(self\&.gold)) -30 if self\&.gold < 0: -31 print('Off to debtorrr's prison\&.') -32 stop = True - return stop -.fi -.SS "def pirate8::Pirate::precmd (self, line)" -.PP -Definition at line 22 of file pirate8\&.py'\&. -.PP -References pirate2::Pirate::gold, pirate3::Pirate::gold, pirate4::Pirate::gold, pirate5::Pirate::gold, pirate6::Pirate::gold, pirate7::Pirate::gold, gold, pirate3::Pirate::initial_gold, pirate4::Pirate::initial_gold, pirate5::Pirate::initial_gold, pirate7::Pirate::initial_gold, initial_gold, and pirate6::Pirate::initial_gold\&. -.PP -Referenced by cmd2::Cmd::onecmd_plus_hooks()\&. -.PP -.nf -22 -23 def precmd(self, line): -24 self\&.initial_gold = self\&.gold - return line -.fi -.SH "Member Data Documentation" -.PP -.SS "string \fBpirate8::Pirate::action\fP = 'store_true'\fC [static]\fP" -.PP -Definition at line 47 of file pirate8\&.py'\&. -.SS "\fBpirate8::Pirate::default_to_shell\fP = True\fC [static]\fP" -.PP -Reimplemented from \fBcmd2::Cmd\fP'\&. -.PP -Definition at line 36 of file pirate8\&.py'\&. -.SS "int \fBpirate8::Pirate::gold\fP = 3\fC [static]\fP" -.PP -Definition at line 5 of file pirate8\&.py'\&. -.PP -Referenced by do_drink(), do_loot(), postcmd(), and precmd()\&. -.SS "string \fBpirate8::Pirate::help\fP = 'How often to chant 'ho''\fC [static]\fP" -.PP -Reimplemented from \fBcmd2::Cmd\fP'\&. -.PP -Definition at line 45 of file pirate8\&.py'\&. -.SS "\fBpirate8::Pirate::initial_gold\fP" -.PP -Definition at line 22 of file pirate8\&.py'\&. -.PP -Referenced by postcmd(), and precmd()\&. -.SS "list \fBpirate8::Pirate::multilineCommands\fP = ['sing']\fC [static]\fP" -.PP -Reimplemented from \fBcmd2::Cmd\fP'\&. -.PP -Definition at line 37 of file pirate8\&.py'\&. -.SS "string \fBpirate8::Pirate::prompt\fP = 'arrr> '\fC [static]\fP" -.PP -Reimplemented from \fBcmd2::Cmd\fP'\&. -.PP -Definition at line 6 of file pirate8\&.py'\&. -.SS "string \fBpirate8::Pirate::settable\fP = '\fBsongcolor\fP Color to ``sing`` in (red/blue/green/cyan/magenta, bold, underline)'\fC [static]\fP" -.PP -Reimplemented from \fBcmd2::Cmd\fP'\&. -.PP -Definition at line 40 of file pirate8\&.py'\&. -.SS "string \fBpirate8::Pirate::songcolor\fP = 'blue'\fC [static]\fP" -.PP -Definition at line 39 of file pirate8\&.py'\&. -.PP -Referenced by do_sing()\&. -.SS "list \fBpirate8::Pirate::terminators\fP = \fBCmd\&.terminators\fP+['\&.\&.\&.']\fC [static]\fP" -.PP -Reimplemented from \fBcmd2::Cmd\fP'\&. -.PP -Definition at line 38 of file pirate8\&.py'\&. - -.SH "Author" -.PP -Generated automatically by Doxygen for Cmd2 from the source code'\&. |