updated the 3.0 branch from the head branch - ready for alpha18
[samba.git] / source3 / utils / net_help.c
1 /* 
2    Samba Unix/Linux SMB client library 
3    net help commands
4    Copyright (C) 2002 Jim McDonough (jmcd@us.ibm.com)
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10    
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  
19 */
20
21 #include "includes.h"
22 #include "../utils/net.h"
23
24 int net_common_methods_usage(int argc, const char**argv)
25 {
26         d_printf("Valid methods: (auto-detected if not specified)\n");
27         d_printf("\tads\t\t\t\tActive Directory (LDAP/Kerberos)\n");
28         d_printf("\trpc\t\t\t\tDCE-RPC\n");
29         d_printf("\trap\t\t\t\tRAP (older systems)\n");
30         d_printf("\n");
31         return 0;
32 }
33
34 int net_common_flags_usage(int argc, const char **argv)
35 {
36         d_printf("Valid targets: choose one (none defaults to localhost)\n");
37         d_printf("\t-S or --server=<server>\t\tserver name\n");
38         d_printf("\t-I or --ipaddress=<ipaddr>\taddress of target server\n");
39         d_printf("\t-w or --workgroup=<wg>\t\ttarget workgroup or domain\n");
40
41         d_printf("\n");
42         d_printf("Valid miscellaneous options are:\n"); /* misc options */
43         d_printf("\t-p or --port=<port>\t\tconnection port on target\n");
44         d_printf("\t-W or --myworkgroup=<wg>\tclient workgroup\n");
45         d_printf("\t-d or --debug=<level>\t\tdebug level (0-10)\n");
46         d_printf("\t-n or --myname=<name>\t\tclient name\n");
47         d_printf("\t-U or --user=<name>\t\tuser name\n");
48         d_printf("\t-s or --conf=<path>\t\tpathname of smb.conf file\n");
49         d_printf("\t-l or --long\t\t\tDisplay full information\n");
50         return -1;
51 }
52
53 static int help_usage(int argc, const char **argv)
54 {
55         d_printf(
56 "\n"\
57 "Usage: net help <function>\n"\
58 "\n"\
59 "Valid functions are:\n"\
60 "  RPC RAP ADS FILE SHARE SESSION SERVER DOMAIN PRINTQ USER GROUP VALIDATE\n"\
61 "  GROUPMEMBER ADMIN SERVICE PASSWORD TIME LOOKUP\n");
62         return -1;
63 }
64
65 int net_help_user(int argc, const char **argv)
66 {
67         d_printf("\nnet <method> user [misc. options] [targets]\n\tList users\n");
68         d_printf("\nnet <method> user DELETE <name> [misc. options] [targets]"\
69                  "\n\tDelete specified user\n");
70         d_printf("\nnet <method> user INFO <name> [misc. options] [targets]"\
71                  "\n\tList the domain groups of the specified user\n");
72         d_printf("\nnet <method> user ADD <name> [password] [-F user flags] [misc. options]"\
73                  " [targets]\n\tAdd specified user\n");
74
75         net_common_methods_usage(argc, argv);
76         net_common_flags_usage(argc, argv);
77         d_printf(
78          "\t-C or --comment=<comment>\tdescriptive comment (for add only)\n");
79         return -1;
80 }
81
82 int net_help_group(int argc, const char **argv)
83 {
84         d_printf("net <method> group [misc. options] [targets]"\
85                  "\n\tList user groups\n\n");
86         d_printf("net <method> group DELETE <name> [misc. options] [targets]"\
87                  "\n\tDelete specified group\n");
88         d_printf("\nnet <method> group ADD <name> [-C comment]"\
89                  " [misc. options] [targets]\n\tCreate specified group\n");
90         net_common_methods_usage(argc, argv);
91         net_common_flags_usage(argc, argv);
92         d_printf(
93          "\t-C or --comment=<comment>\tdescriptive comment (for add only)\n");
94         return -1;
95 }
96
97 int net_help_share(int argc, const char **argv)
98 {
99         d_printf(
100          "\nnet <method> share [misc. options] [targets] \n"
101          "\tenumerates all exported resources (network shares) "
102          "on target server\n"
103          "\nnet <method> share ADD <name=serverpath> [misc. options] [targets]"
104          "\n\tAdds a share from a server (makes the export active)\n"
105          "\nnet <method> share DELETE <sharename> [misc. options] [targets]\n"
106          "\n\tDeletes a share from a server (makes the export inactive)\n");
107         net_common_methods_usage(argc, argv);
108         net_common_flags_usage(argc, argv);
109         d_printf(
110          "\t-C or --comment=<comment>\tdescriptive comment (for add only)\n"
111          "\t-M or --maxusers=<num>\t\tmax users allowed for share\n");
112         return -1;
113 }
114
115 int net_help_file(int argc, const char **argv)
116 {
117         d_printf("net <method> file [misc. options] [targets]\n"\
118                  "\tlists all open files on file server\n\n");
119         d_printf("net <method> file USER <username> [misc. options] [targets]"\
120                  "\n\tlists all files opened by username on file server\n\n");
121         d_printf("net <method> file CLOSE <id> [misc. options] [targets]\n"\
122                  "\tcloses specified file on target server\n\n");
123         d_printf("net [rap] file INFO <id> [misc. options] [targets]\n"\
124                  "\tdisplays information about the specified open file\n");
125
126         net_common_methods_usage(argc, argv);
127         net_common_flags_usage(argc, argv);
128         return -1;
129 }
130
131 static int net_usage(int argc, const char **argv)
132 {
133         d_printf("  net time\t\tto view or set time information\n"\
134                  "  net lookup\t\tto lookup host name or ip address\n"\
135                  "  net user\t\tto manage users\n"\
136                  "  net group\t\tto manage groups\n"\
137                  "  net join\t\tto join a domain\n"\
138                  "\n"\
139                  "  net ads <command>\tto run ADS commands\n"\
140                  "  net rap <command>\tto run RAP (pre-RPC) commands\n"\
141                  "  net rpc <command>\tto run RPC commands\n"\
142                  "\n"\
143                  "Type \"net help <option>\" to get more information on that option\n");
144         return -1;
145 }
146
147 /*
148   handle "net help *" subcommands
149 */
150 int net_help(int argc, const char **argv)
151 {
152         struct functable func[] = {
153                 {"ADS", net_ads_help},  
154                 {"RAP", net_rap_help},
155                 {"RPC", net_rpc_help},
156
157                 {"FILE", net_help_file},
158                 {"SHARE", net_help_share},
159                 {"SESSION", net_rap_session_usage},
160                 {"SERVER", net_rap_server_usage},
161                 {"DOMAIN", net_rap_domain_usage},
162                 {"PRINTQ", net_rap_printq_usage},
163                 {"USER", net_help_user},
164                 {"GROUP", net_help_group},
165                 {"VALIDATE", net_rap_validate_usage},
166                 {"GROUPMEMBER", net_rap_groupmember_usage},
167                 {"ADMIN", net_rap_admin_usage},
168                 {"SERVICE", net_rap_service_usage},
169                 {"PASSWORD", net_rap_password_usage},
170                 {"TIME", net_time_usage},
171                 {"LOOKUP", net_lookup_usage},
172
173                 {"HELP", help_usage},
174                 {NULL, NULL}};
175
176         return net_run_function(argc, argv, func, net_usage);
177 }