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

FreeBSD Manual Pages

  
 
  

home | help
FISH(1)				  fish-shell			       FISH(1)

NAME
       fish - the friendly interactive shell

SYNOPSIS
	  fish [OPTIONS] [-c command] [FILE] [ARGUMENTS...]

DESCRIPTION
       fish  is	 a  command-line  shell	written	mainly with interactive	use in
       mind. This page briefly describes the options for  invoking  fish.  The
       full  manual is available in HTML by using the help command from	inside
       fish, and in the	fish-doc(1) man	page. The  tutorial  is	 available  as
       HTML via	help tutorial or in fish-tutorial(1).

       The following options are available:

       o -c  or	 --command=COMMANDS evaluate the specified commands instead of
	 reading from the commandline, passing any additional positional argu-
	 ments	via  $argv. Note that, unlike other shells, the	first argument
	 is not	the name of the	program	($0), but simply the first normal  ar-
	 gument.

       o -C  or	 --init-command=COMMANDS evaluate the specified	commands after
	 reading the configuration, before running the command specified by -c
	 or reading interactive	input

       o -d or --debug=DEBUG_CATEGORIES	enable debug output and	specify	a pat-
	 tern for matching debug categories. See Debugging below for details.

       o -o or --debug-output=DEBUG_FILE specify a file	path  to  receive  the
	 debug	output,	 including  categories	and fish_trace.	The default is
	 stderr.

       o -i or --interactive specify that fish is to run in interactive	mode

       o -l or --login specify that fish is to run as a	login shell

       o -n or --no-execute do not execute any commands, only  perform	syntax
	 checking

       o -p  or	--profile=PROFILE_FILE when fish exits,	output timing informa-
	 tion on all executed commands to the specified	 file.	This  excludes
	 time spent starting up	and reading the	configuration.

       o --profile-startup=PROFILE_FILE	 will  write  timing  information  for
	 fish's	startup	to the specified file. This is useful to profile  your
	 configuration.

       o -P  or	--private enables private mode,	so fish	will not access	old or
	 store new history.

       o --print-rusage-self when fish exits, output stats from	getrusage

       o --print-debug-categories outputs the list of  debug  categories,  and
	 then exits.

       o -v or --version display version and exit

       o -f  or	 --features=FEATURES  enables one or more feature flags	(sepa-
	 rated by a comma). These are how fish stages changes that might break
	 scripts.

       The  fish  exit	status	is generally the exit status of	the last fore-
       ground command.

DEBUGGING
       While fish provides extensive support for debugging fish	scripts, it is
       also  possible  to debug	and instrument its internals. Debugging	can be
       enabled by passing the --debug option. For example, the following  com-
       mand turns on debugging for background IO thread	events,	in addition to
       the default categories, i.e. debug, error, warning, and warning-path:

	  > fish --debug=iothread

       Available categories are	listed by fish	--print-debug-categories.  The
       --debug	option	accepts	a comma-separated list of categories, and sup-
       ports glob syntax. The following	command	turns on  debugging  for  com-
       plete,  history,	 history-file, and profile-history, as well as the de-
       fault categories:

	  > fish --debug='complete,*history*'

       Debug messages output to	stderr by default. Note	that if	fish_trace  is
       set,  execution tracing also outputs to stderr by default. You can out-
       put to a	file using the --debug-output option:

	  > fish --debug='complete,*history*' --debug-output=/tmp/fish.log --init-command='set fish_trace on'

       These options can also be changed via  the  $FISH_DEBUG	and  $FISH_DE-
       BUG_OUTPUT  variables.  The categories enabled via --debug are added to
       the ones	enabled	by $FISH_DEBUG,	so they	can be disabled	 by  prefixing
       them  with  - (reader-*,-ast* enables reader debugging and disables ast
       debugging).

       The file	given in --debug-output	takes  precedence  over	 the  file  in
       $FISH_DEBUG_OUTPUT.

COPYRIGHT
       2021, fish-shell	developers

3.3				 Nov 06, 2021			       FISH(1)

NAME | SYNOPSIS | DESCRIPTION | DEBUGGING | COPYRIGHT

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

home | help