commands/lbs/lbs.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # lbs.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 lbs
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Retrieve location information.
       
    18 
       
    19 ==argument enum command optional
       
    20 
       
    21 The command to perform.
       
    22 
       
    23 ==enum-value location
       
    24 
       
    25 Get a location reading.
       
    26 
       
    27 ==enum-value modules
       
    28 
       
    29 List information about installed modules.
       
    30 
       
    31 ==enum-value modules60
       
    32 
       
    33 The same as 'modules', but based on a proprietary S60 API (can be used to verify the results).
       
    34 
       
    35 ==enum-value enable
       
    36 
       
    37 Enable a particular module (S60 proprietary).
       
    38 
       
    39 ==enum-value disable
       
    40 
       
    41 Disable a particular module (S60 proprietary).
       
    42 
       
    43 ==option bool v verbose multiple
       
    44 
       
    45 Verbose mode. Specify twice (eg -vv) for even more details.
       
    46 
       
    47 ==option uint m module-index
       
    48 
       
    49 Specify which module to use (note, module B<index>, not module B<id>). If not specified, the first module available in module list will be used.
       
    50 
       
    51 ==option uint l loops
       
    52 
       
    53 Specify how many loops needed to retrieve location information. Defaults to 1.
       
    54 
       
    55 ==option uint t timeout
       
    56 
       
    57 Specify a timeout value in seconds to be used before reporting a timeout error. Defaults to 300 seconds. Note, it can take over an hour to get a reading in some circumstance.
       
    58 
       
    59 ==copyright
       
    60 
       
    61 Copyright (c) 2008-2010 Accenture. All rights reserved.
       
    62