core/builtins/date.cif
changeset 0 7f656887cf89
child 7 184a1eb85cf2
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # date.cif
       
     2 # 
       
     3 # Copyright (c) 2010 Accenture. All rights reserved.
       
     4 # This component and the accompanying materials are made available
       
     5 # under the terms of the "Eclipse Public License v1.0"
       
     6 # which accompanies this distribution, and is available
       
     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 # 
       
     9 # Initial Contributors:
       
    10 # Accenture - Initial contribution
       
    11 #
       
    12 
       
    13 ==name date
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Displays or sets the current time and date.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 Example usage:
       
    22 
       
    23 To get the current date and time:
       
    24 
       
    25     c:\>date
       
    26     07/04/2010 13:46:58.647500
       
    27 
       
    28 To check how a human readable date is parsed:
       
    29 
       
    30     c:\>date --set --just-display "07/04/2010 13:47:00"
       
    31     07/04/2010 13:47:00.000000
       
    32 
       
    33 To convert a raw TInt64 timestamp to a human-readable string:
       
    34 
       
    35     c:\>date --raw-set 1234567890 --display-only
       
    36     01/01/0000 00:20:34.567890
       
    37 
       
    38 To set the current local time:
       
    39 
       
    40     c:\>date --set "07/04/2010 13:47:00"
       
    41     c:\>
       
    42 
       
    43 To use a timestamp in a filename:
       
    44 
       
    45     date --timestamp | export -s TIMESTAMP
       
    46     do-something > C:\logs\myoutput-$TIMESTAMP.txt
       
    47 
       
    48 ==option bool u universal
       
    49 
       
    50 Display or set universal time (UTC) rather than local time.
       
    51 
       
    52 ==option string s set
       
    53 
       
    54 Sets the time and date. Format is that accepted by TTime::Parse(). For UK English localisations, C<DD/MM/YYYY HH:MM:SS> is one such acceptable format.
       
    55 
       
    56 ==option int o utc-offset
       
    57 
       
    58 Sets the UTC offset in seconds. Must be used in conjunction with the C<--set> option.
       
    59 
       
    60 ==option bool S secure
       
    61 
       
    62 Displays or sets the secure variant of the kernel's reckoning of time.
       
    63 
       
    64 ==option bool r raw
       
    65 
       
    66 Displays the time and date as the number of microseconds since 2000AD (Symbian OS's native time format).
       
    67 
       
    68 ==option bool j just-display
       
    69 
       
    70 Rather than going ahead and setting the specified time and date, do a dry run and just displays it in human readable form. Must be used in conjunction with C<--set>. In effect it is an option to check that the set string has been parsed correctly before actually making the change.
       
    71 
       
    72 ==option int64 R raw-set
       
    73 
       
    74 Sets the time and date from a number corresponding to the number of microseconds since 2000AD (Symbian OS's native time format).
       
    75 
       
    76 ==option bool t timestamp
       
    77 
       
    78 Display the date in timestamp format C<YYYYMMDD-HHMM.SS> suitable for use in a file name.
       
    79 
       
    80 ==copyright
       
    81 
       
    82 Copyright (c) 2006-2010 Accenture. All rights reserved.
       
    83