Skip to content

Commit

Permalink
Update deb doc
Browse files Browse the repository at this point in the history
  • Loading branch information
fxpineau committed Apr 5, 2024
1 parent afc5672 commit 625dd55
Showing 1 changed file with 34 additions and 37 deletions.
71 changes: 34 additions & 37 deletions crates/cli/doc/vot.1.txt.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -3,57 +3,54 @@ vot(1)

Name
----
vot - convert VOTable abck and forth in XML, JSON, TOML and YAML.
vot - extract/edit information from IVOA VOTables and to convert VOTable
back and forth in XML, JSON, YAML, TOML (and to CSV)
while preserving all elements (except in CSV).


Synopsis
--------

*vot* _FORMAT_IN_ _FORMAT_OUT_ _OPTION_

*vot* *--help*

*vot* *--version*

*command* | *vot* [xml|json|toml|yaml] [xml|json|toml|yaml] [_OPTION_]


FORMAT_IN
---------

_xml_::
Regular XML VOtable


_json_::
JSON encoded VOTable
*vot* *SUB_COMMAND* *--help*

_toml_::

TOML encoded VOTable

_yaml_::
YAML encoded VOTable

OPTION
------
_-i_, _--input_::
Path of the input file (else read from stdin)

_-o_, _--output_ ::
Path of the output file (else printon stdout)

_-p_, _--pretty_::
Use pretty print for JSON and TOML
*vot* *--version*



Examples
--------

vot xml json --pretty -i FILE_IN

cat VOT_FILE | vot xml xml
RUST_LOG=warn vot sconvert --in FILE_IN --out FILE_OUT --out-fmt xml-bin --parallel 3

RUST_LOG=warn vot get --in FILE_IN struct

RUST_LOG=warn vot edit --in ${in} --out-fmt xml-td --streaming \
-e 'RESOURCE vid=DR1R1 rm' \
-e 'RESOURCE vid=DR1 set_attrs ID=R1 name=main_resource' \
-e 'RESOURCE vid=DR1 set_description The main resource containing my super table' \
-e 'RESOURCE vid=DR1 push_coosys ID=t4-coosys-1 system=eq_FK4 equinox=B1900
@push_fieldref ref=RA1900
@@set_content Ref to the RA column @<
@push_fieldref ref=DE1900
@@set_content Ref to the Declination column @<' \
-e 'PARAM name=votable-version rm' \
-e 'PARAM name=-ref rm' \
-e 'PARAM name=-out.max rm' \
-e 'PARAM name=queryParameters rm' \
-e 'TABLE name=I/238A/picat push_param name=hpx_order datatype=unsignedByte value=8
@set_description HEALPix order
@set_values
@@set_min value=0 inclusive=true
@set_max value=29 inclusive=true
@<
@push_link href=https://en.wikipedia.org/wiki/HEALPix
@@set_content General HEALPix info on Wikipedia @<' \
-e 'FIELD name=recno set_attrs name=RecordNumber' \
-e 'LINK vid=DR1T1F27l1 rm' \
-e 'TABLE name=I/238A/picat push_info name=ps value=my post-scriptum @set_content My super post-scriptum' \
-e 'VOTABLE vid=D push_post_info name=warning value=This table has been modified by using vot-cli'


DESCRIPTION
Expand Down

0 comments on commit 625dd55

Please sign in to comment.