Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
ceylon(1)							     ceylon(1)

NAME
       ceylon  -  The  top  level  Ceylon tool is used to execute other	Ceylon
       tools

SYNOPSIS
       ceylon {--version}
       ceylon [--stacktraces] [--paginate] [--no-pager]	[--show-home]
	      [--cwd=dir] [--config=file] [--no-config]
	      [--define=key_=_value...]	[--distribution=version-or-url]
	      [--java=options] [--] {command} [command-options]... [command-
	      args]...

DESCRIPTION
       If --version is present,	print version information and exit.  Otherwise
       <tool-arguments>	 should	begin with the name of a ceylon	tool or	a list
       of comma-separated tool names which will	be invoked one after the other
       with  the  same	remaining  command line	arguments. The named tools are
       loaded and configured with the remaining	 command  line	arguments  and
       control passes to those tools.

       o assemble - Generate a Ceylon assembly for a given module

       o bootstrap - Generates a Ceylon	bootstrap script in the	current	direc-
	 tory

       o browse	- Open module documentation in the browser

       o classpath - Prints a classpath	suitable for passing to	Java tools  to
	 run a given Ceylon module

       o compile  - Compiles Ceylon and	Java source code and directly produces
	 module	and source archives in a module	repository.

       o compile-js - Compiles Ceylon source code to JavaScript	 and  directly
	 produces module and source archives in	a module repository

       o config	- Manages Ceylon configuration files

       o copy -	Copies modules from one	Ceylon module repository to another

       o doc - Generates Ceylon	API documentation from Ceylon source files

       o doc-tool - Generates documentation about a tool

       o fat-jar - Generate a Ceylon executable	jar for	a given	module

       o help -	Displays help information about	other Ceylon tools

       o import-jar - Imports a	jar file into a	Ceylon module repository

       o info -	Prints information about modules in repositories

       o jigsaw	- Tools	to interop with	Java 9 (Jigsaw)	modules

       o maven-export -	Generate a Maven repository for	a given	module

       o new - Generates a new Ceylon project

       o plugin	- Manages Ceylon command-line plugins

       o run - Executes	a Ceylon program on the	JVM

       o run-js	- Executes a Ceylon program on Node.js

       o src  -	 Fetches  source archives from a repository and	extracts their
	 contents into a source	directory

       o test -	Executes tests on the JVM

       o test-js - Executes tests on Node.js

       o version - Shows and updates version numbers in	module descriptors

       o war - Generates a WAR file from a compiled .car file

       See ceylon help <command> for more information about a particular  sub-
       command.

OPTIONS
       --config=file
	      Specifies	the configuration file to use for this tool. (default:
	      ./.ceylon/config)

       --cwd=dir
	      Specifies	the current working directory for this tool. (default:
	      the directory where the tool is run from)

       --define=key_=_value, -D	key_=_value
	      Set a system property

       --distribution=version-or-url
	      Determines  which	 Ceylon	 distribution  will be used to run the
	      command. Passing any version except the current (1.3.3) will re-
	      sult  in	a  one-time download of	the requested version from the
	      official Ceylon website.

       --java=options
	      Flags added to the java command line, overriding	the  JAVA_OPTS
	      environment variable.

       --no-config
	      Specifies	 that  no configuration	file should be loaded for this
	      tool.

       --no-pager
	      Do not pipe Ceylon tool output into a pager.

       --paginate
	      Pipe all Ceylon tool output into less (or	if set,	 $CEYLON_PAGER
	      or  $PAGER) if standard output is	a terminal. This overrides the
	      help.pager and defaults.pager  configuration  options  (see  the
	      "Configuration Mechanism"	section	below).

       --show-home
	      Outputs the value	for CEYLON_HOME	and exits.

       --stacktraces
	      If  an  error  propagates	to the top level tool, print its stack
	      trace.

       --version, -v
	      Print version information	and exit, null.

CONFIGURATION MECHANISM
       Ceylon uses a simple text format	to store customizations	that  are  per
       repository  and	are  per user. Such a configuration file may look like
       this:

       #
       # A '#' or ';' character	indicates a comment.
       #

       ; global	settings
       [defaults]
	   encoding = utf8
	   pager = false

       ; local repository
       [repository "LOCAL"]
	   url = ./modules

       .fi

       Various commands	read from the configuration file and adjust their operation accordingly. See ceylon-config(1) for a list and more details about	the configuration mechanism.

				18 August 2017			     ceylon(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | CONFIGURATION MECHANISM

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=ceylon&sektion=1&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help