Improved CLI toosl man pages. (c7612630) · Commits · VOSpace INAF / vospace-transfer-service

client/vos_data

+14 −1

Original line number	Diff line number	Diff line
		@@ -47,6 +47,20 @@ DESCRIPTION

		The client also needs to know the username associated to a storage request process.
		The username must be the same used for accessing the transfer node.

		EXAMPLES
		1) Perform a hot storage request for the data contained in the 'store path' associated
		to the user 'john.smith':

		# vos_data hstore john.smith

		2) Perform a cold storage request for the data contained in the 'store path' associated
		to the user 'john.smith':

		# vos_data cstore john.smith

		The 'store path' parameter is defined in the 'storage section' of the transfer service
		main configuration file: '/etc/vos_ts/vos_ts.conf'.
		""")

		def store(self, cmd, username):
		@@ -134,4 +148,3 @@ if cmd == "cstore" or cmd == "hstore":
		vosDataCli.store(cmd, username)
		else:
		vosDataCli.help()

+12 −3

Original line number	Diff line number	Diff line
		@@ -97,7 +97,7 @@ NAME
		vos_group

		SYNOPSYS
		vos_group GROUP_TYPE METHOD GROUP_NAME VOSPACE_PATH
		vos_group GROUP_TYPE METHOD [GROUP_NAME] VOSPACE_PATH

		DESCRIPTION
		This tool allows to modify 'group_read' and 'group_write'
		@@ -125,12 +125,21 @@ DESCRIPTION
		represents the node VOSpace path.

		EXAMPLES
		Add 'jane.lee' to 'group_read' for the VOSpace node '/john.smith/test/foo' and any child nodes:
		1) Add 'jane.lee' to 'group_read' for the VOSpace node '/john.smith/test/foo' and any child nodes:

		# vos_group read add people.jane\\\.lee /john.smith/test/foo

		Add 'my_group' to 'group_write' for the VOSpace node '/john.smith/test/foo' and any child nodes:
		2) Add 'my_group' to 'group_write' for the VOSpace node '/john.smith/test/foo' and any child nodes:

		# vos_group write add my_group /john.smith/test/foo

		3) Remove 'my_group' from 'group_write' for the VOSpace node '/john.smith/test/foo' and any child nodes:

		# vos_group write del my_group /john.smith/test/foo

		4) List all groups in 'group_read' for the VOSpace node '/john.smith/test/foo':

		# vos_group read list /john.smith/test/foo
		""")

		# Create new VOSChcrt object

+9 −3

Original line number	Diff line number	Diff line
		@@ -53,17 +53,23 @@ DESCRIPTION
		Two parameters are required:

		DIR_PATH:
		the physical absolute path of a directory located within the
		user directory for a given mount point
		the physical absolute path of a directory located in the first
		level of the user directory for a given mount point

		USERNAME:
		the username used for accessing the transfer node

		EXAMPLE
		The following command will import recursively all the nodes contained
		1) The following command will import recursively all the nodes contained
		in 'mydir' on the VOSpace for the 'jsmith' user:

		# vos_import /mnt/storage/users/jsmith/mydir jsmith

		2) The following command will import recursively all the nodes contained
		in the timestamp-wrapper-dir '2021_03_03-13_46_34-vos_wrapper' on the
		VOSpace for the 'jsmith' user:

		# vos_import /mnt/storage/users/jsmith/2021_03_03-13_46_34-vos_wrapper jsmith
		""")

		# Create new VOSImport object

+2 −2

Original line number	Diff line number	Diff line
		@@ -115,11 +115,11 @@ DESCRIPTION

		info
		prints a JSON object containing the job info according to the UWS specification.
		A job id is required as argument.
		A job ID is required as argument.

		results
		prints a JSON object containing the job results according to the UWS specification.
		A job id is required as argument.
		A job ID is required as argument.
		""")

		# Create new VOSJob object

+10 −1

Original line number	Diff line number	Diff line
		@@ -31,7 +31,7 @@ class VOSStorage(RedisRPCClient):
		storageHostname = None
		while not storageType in ("cold", "hot", "portal"):
		try:
		storageType = input("\nStorage type [cold, hot or portal]: ")
		storageType = input("\nStorage type ['cold', 'hot' or 'portal']: ")
		except ValueError:
		print("Input type is not valid!")
		except EOFError:
		@@ -179,6 +179,15 @@ DESCRIPTION

		list
		prints the full storage point list


		Supported storage types are: 'hot', 'cold' and 'portal'.

		Adding 'hot' or 'cold' storage points requires a base path
		to be specified (e.g. '/mnt/my_storage/users').
		For 'portal' storage points a base URL is required.

		All storage points require a valid hostname or IP address.
		""")

		# Create new VOSStorage object