s4: samba-tool time --help documentation improvements
authorTheresa Halloran <thallora@linux.vnet.ibm.com>
Thu, 10 Nov 2011 01:16:33 +0000 (20:16 -0500)
committerAndrew Tridgell <tridge@samba.org>
Thu, 10 Nov 2011 05:04:22 +0000 (06:04 +0100)
Signed-off-by: Theresa Halloran <thallora@linux.vnet.ibm.com>
Signed-off-by: Andrew Tridgell <tridge@samba.org>
Autobuild-User: Andrew Tridgell <tridge@samba.org>
Autobuild-Date: Thu Nov 10 06:04:22 CET 2011 on sn-devel-104

source4/scripting/python/samba/netcmd/time.py

index 62d4d1ba3c198c38dafb1ab096755eb5e3b74783..966799e7db714dff3191021a53cfe4fdc0791f5d 100644 (file)
@@ -28,7 +28,20 @@ from samba.netcmd import (
     )
 
 class cmd_time(Command):
-    """Retrieve the time on a remote server"""
+    """Retrieve the time on a server
+
+This command returns the date and time of the Active Directory server specified on the command.  The server name specified may be the local server or a remote server.  If the servername is not specified, the command returns the time and date of the local AD server.
+
+Example1:
+samba-tool time samdom.example.com
+
+Example1 returns the date and time of the server samdom.example.com.
+
+Example2:
+samba-tool time
+
+Example2 return the date and time of the local server.
+"""
     synopsis = "%prog [server-name] [options]"
 
     takes_args = ["server_name?"]