[dab82f29] | 1 | /* Copyright (c) 2002,2003,2004,2009 James M. Kretchmar |
---|
| 2 | * |
---|
| 3 | * This file is part of Owl. |
---|
| 4 | * |
---|
| 5 | * Owl is free software: you can redistribute it and/or modify |
---|
| 6 | * it under the terms of the GNU General Public License as published by |
---|
| 7 | * the Free Software Foundation, either version 3 of the License, or |
---|
| 8 | * (at your option) any later version. |
---|
| 9 | * |
---|
| 10 | * Owl is distributed in the hope that it will be useful, |
---|
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 13 | * GNU General Public License for more details. |
---|
| 14 | * |
---|
| 15 | * You should have received a copy of the GNU General Public License |
---|
| 16 | * along with Owl. If not, see <http://www.gnu.org/licenses/>. |
---|
| 17 | * |
---|
| 18 | * --------------------------------------------------------------- |
---|
| 19 | * |
---|
| 20 | * As of Owl version 2.1.12 there are patches contributed by |
---|
| 21 | * developers of the the branched BarnOwl project, Copyright (c) |
---|
| 22 | * 2006-2008 The BarnOwl Developers. All rights reserved. |
---|
| 23 | */ |
---|
| 24 | |
---|
[7d4fbcd] | 25 | #include "owl.h" |
---|
| 26 | #include <string.h> |
---|
| 27 | |
---|
[1aee7d9] | 28 | static const char fileIdent[] = "$Id$"; |
---|
| 29 | |
---|
[15283bb] | 30 | void owl_help() |
---|
| 31 | { |
---|
[7d4fbcd] | 32 | owl_fmtext fm; |
---|
| 33 | char *varname; |
---|
| 34 | owl_list varnames; |
---|
| 35 | int i, numvarnames; |
---|
| 36 | |
---|
| 37 | owl_fmtext_init_null(&fm); |
---|
| 38 | owl_fmtext_append_bold |
---|
[6794f72] | 39 | (&fm, |
---|
| 40 | "OWL HELP\n\n"); |
---|
[7d4fbcd] | 41 | |
---|
| 42 | owl_fmtext_append_normal |
---|
[6794f72] | 43 | (&fm, |
---|
| 44 | " For help on a specific command use 'help <command>'\n" |
---|
| 45 | " For information on advanced keys, use 'show keymaps'.\n" |
---|
| 46 | " For information on advanced commands, use 'show commands'.\n" |
---|
| 47 | " For information on variables, use 'show variables'.\n\n"); |
---|
[7d4fbcd] | 48 | |
---|
| 49 | owl_fmtext_append_bold |
---|
[6794f72] | 50 | (&fm, |
---|
| 51 | " Basic Keys:\n" |
---|
| 52 | ); |
---|
[7d4fbcd] | 53 | owl_fmtext_append_normal |
---|
[6794f72] | 54 | (&fm, |
---|
| 55 | " n Move to next non-deleted message\n" |
---|
| 56 | " p Move to previous non-deleted message\n" |
---|
| 57 | " C-n , down Move to next message\n" |
---|
| 58 | " C-p , up Move to previous message\n" |
---|
| 59 | " < , > Move to first, last message\n" |
---|
| 60 | " right , left Scroll screen left or right\n" |
---|
| 61 | " C-v Page down\n" |
---|
| 62 | " M-v Page up\n" |
---|
| 63 | " i Print more information about a message\n" |
---|
| 64 | " P Move to the next personal message\n" |
---|
| 65 | " M-P Move to the preivous personal message\n" |
---|
| 66 | "\n" |
---|
| 67 | " d Mark message for deletion\n" |
---|
| 68 | " u Undelete a message marked for deletion\n" |
---|
| 69 | " x Expunge deleted messages\n" |
---|
[15283bb] | 70 | " X Expunge deleted messages and switch to home view\n" |
---|
[6794f72] | 71 | " T Mark all 'trash' messages for deletion\n" |
---|
| 72 | " M-D Mark all messages in current view for deletion\n" |
---|
| 73 | " M-u Unmark all messages in the current view for deletion\n" |
---|
| 74 | "\n" |
---|
| 75 | " z Start a zwrite command\n" |
---|
[15283bb] | 76 | " a Start an aimwrite command\n" |
---|
[6794f72] | 77 | " r Reply to the current message\n" |
---|
| 78 | " R Reply to sender\n" |
---|
| 79 | " C-r Reply but allow editing of reply line\n" |
---|
| 80 | "\n" |
---|
[15283bb] | 81 | " M-n View zephyrs in selected conversation\n" |
---|
| 82 | " M-N View zephyrs in selected converstaion of instance\n" |
---|
[65fc0900] | 83 | " V Change to back to home view ('all' by default)\n" |
---|
[6794f72] | 84 | " v Start a view command\n" |
---|
[3895e23] | 85 | " ! Invert the current view\n" |
---|
[6794f72] | 86 | "\n" |
---|
[15283bb] | 87 | " l Print a zephyr/AIM buddy listing\n" |
---|
[6794f72] | 88 | " A Toggle zaway\n" |
---|
[15283bb] | 89 | " o Toggle one-line display mode\n" |
---|
| 90 | " w Open a URL in the current message\n" |
---|
[6794f72] | 91 | " C-l Refresh the screen\n" |
---|
[15283bb] | 92 | " C-z Suspend Owl\n" |
---|
[6794f72] | 93 | " h Print this help message\n" |
---|
[bde7714] | 94 | " : , M-x Enter command mode\n" |
---|
[55faab7] | 95 | "\n" |
---|
| 96 | " / Foward search\n" |
---|
| 97 | " ? Reverse search\n" |
---|
[6794f72] | 98 | "\n\n" |
---|
| 99 | ); |
---|
[7d4fbcd] | 100 | owl_fmtext_append_bold |
---|
[6794f72] | 101 | (&fm, |
---|
| 102 | " Basic Commands:\n" |
---|
| 103 | ); |
---|
[7d4fbcd] | 104 | owl_fmtext_append_normal |
---|
[6794f72] | 105 | (&fm, |
---|
| 106 | " quit, exit Exit owl\n" |
---|
| 107 | " help Get help about commands\n" |
---|
| 108 | " show Show information about owl (see detailed help)\n" |
---|
| 109 | "\n" |
---|
| 110 | " zwrite Send a zephyr\n" |
---|
[15283bb] | 111 | " aimlogin Login to AIM\n" |
---|
| 112 | " aimwrite Send an AIM message\n" |
---|
[6794f72] | 113 | "\n" |
---|
[15283bb] | 114 | " addbuddy Add a zephyr or AIM buddy\n" |
---|
| 115 | " zaway Turn zaway on or off, or set the message\n" |
---|
| 116 | " zlocate Locate a user\n" |
---|
[6794f72] | 117 | " subscribe Subscribe to a zephyr class or instance\n" |
---|
| 118 | " unsubscribe Unsubscribe to a zephyr class or instance\n" |
---|
[15283bb] | 119 | " blist Print a list of zephyr and AIM buddies logged in\n" |
---|
| 120 | " search Search for a text string\n" |
---|
| 121 | "\n" |
---|
| 122 | " set Set a variable (see list below)\n" |
---|
| 123 | " print Print a variable's value (variables listed below)\n" |
---|
| 124 | " startup Set a command to be run at every Owl startup\n" |
---|
| 125 | " unstartup Remove a command to be run at every Owl startup\n" |
---|
| 126 | "\n" |
---|
[6794f72] | 127 | " getsubs Print a list of current subscriptions\n" |
---|
[15283bb] | 128 | " unsuball Unsubscribe from all zephyr classes\n" |
---|
| 129 | " load-subs Load zephyr subscriptions from a file\n" |
---|
| 130 | " zpunt Supress messages from a zephyr triplet\n" |
---|
| 131 | " zlog Send a login or logout notification\n" |
---|
| 132 | " zlist Print a list of zephyr buddies logged in\n" |
---|
| 133 | " alist Print a list of AIM buddies logged in\n" |
---|
[6794f72] | 134 | " info Print detailed information about the current message\n" |
---|
| 135 | " filter Create a message filter\n" |
---|
| 136 | " view View messages matching a filter\n" |
---|
| 137 | " viewuser View messages to or from a particular user\n" |
---|
| 138 | " viewclass View messages to a particular class\n" |
---|
| 139 | " expunge Expunge messages marked for deletion\n" |
---|
[15283bb] | 140 | " bindkey Create a new key binding\n" |
---|
| 141 | " alias Create a command alias\n" |
---|
| 142 | " dump\n" |
---|
[6794f72] | 143 | "\n" |
---|
| 144 | " about Print information about owl\n" |
---|
| 145 | " status Print status information about the running owl\n" |
---|
| 146 | " version Print the version number of owl\n" |
---|
| 147 | "\n"); |
---|
[7d4fbcd] | 148 | |
---|
| 149 | /* help for variables */ |
---|
| 150 | owl_fmtext_append_bold(&fm, |
---|
[6794f72] | 151 | "Variables:\n"); |
---|
[7d4fbcd] | 152 | owl_variable_dict_get_names(owl_global_get_vardict(&g), &varnames); |
---|
| 153 | numvarnames = owl_list_get_size(&varnames); |
---|
| 154 | for (i=0; i<numvarnames; i++) { |
---|
| 155 | varname = owl_list_get_element(&varnames, i); |
---|
| 156 | if (varname && varname[0]!='_') { |
---|
[aa2f33b3] | 157 | owl_variable_describe(owl_global_get_vardict(&g), varname, &fm); |
---|
[7d4fbcd] | 158 | } |
---|
| 159 | } |
---|
| 160 | owl_variable_dict_namelist_free(&varnames); |
---|
| 161 | |
---|
| 162 | owl_fmtext_append_normal(&fm, "\n"); |
---|
| 163 | |
---|
| 164 | owl_function_popless_fmtext(&fm); |
---|
| 165 | |
---|
| 166 | owl_fmtext_free(&fm); |
---|
| 167 | } |
---|