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

FreeBSD Manual Pages

  
 
  

home | help
gerbera(1)							      gerbera(1)

NAME
     gerbera - UPnP MediaServer

SYNOPSIS
     gerbera [ -h|--help ] [ -D|--debug ] [ -v|--version ] [ --compile-info ] [
	     --create-config=Sections ] [ --create-example-config=Sections ] [
	     --create-advanced-config=Sections ] [ --check-config ] [ --print-
	     options ] [ --offline ] [ --drop-tables ] [ --init-lastfm ] [
	     -d|-daemon ] [ -u|--user username ] [ -P|--pidfile pid file ] [
	     -c|--config config file ] [ -f|--cfgdir config dir ] [ -l|--logfile
	     logfile ] [ --rotatelog logfile ] [ --syslog LOG ] [ --add-file
	     file ] [ --set-option opt=val ] [ -p|--port port ] [ -i|--ip IP
	     address ] [ -e|--interface interface ] [ -m|--home home dir ] [
	     --magic magic ] [ --import-mode mt|grb ] [ -l|--debug-mode
	     facilities ]

DESCRIPTION
     This  manual  page describes the command line parameters for Gerbera. For a
     detailed documentation please see the README file which is distributed with
     Gerbera or visit https://gerbera.io.

OPTIONS
     -i, --ip
	    The server will bind to the given IP address, currently we	can  not
	    bind to multiple interfaces so binding to 0.0.0.0 will not be possi-
	    ble.

     -e, --interface
	    The  server  will  bind to the given network interface, currently we
	    can only bind to one interface at a time.

     -p, --port
	    Specify the server port that will be used for the  web  user  inter-
	    face, for serving media and for UPnP requests, minimum allowed value
	    is	49152.	If this option is omitted a default port will be chosen,
	    however, in this case it is possible that the port will change  upon
	    server restart.

     -u, --user
	    Drop privs to user on startup. Make sure all mediafiles are readable
	    by	this  user.   Also make sure that home directory is writable for
	    this user.

     -c, --config
	    By default Gerbera will search for a file named "config.xml" in  the
	    ~/.config/gerbera  directory.   This  option allows you to specify a
	    config file by the name and location of your choice. The  file  name
	    must be absolute.

     -m, --home
	    Specify  an  alternative home directory. By default Gerbera will try
	    to retrieve the users home directory from  the  environment  (HOME),
	    then  it  will look for the .config/gerbera directory in users home.
	    If .config/gerbera was found we will try to find the default config-
	    uration file (config.xml).

	    This option is useful in two cases: when the home  directory  cannot
	    be	retrieved  from the environment (in this case you could also use
	    -c to point Gerbera to your configuration file) or when you want  to
	    test  a  new  configuration in a non standard location (for example,
	    when setting up daemon mode). In the latter  case  you  can  combine
	    this parameter with the parameter described in "Config Directory"

     -f, --cfgdir
	    The  default  configuration  directory is combined by the users home
	    and the default that equals to .config/gerbera, this  option  allows
	    you  to  override  the default directory naming. This is useful when
	    you want to set up the server in a nonstandard location.

     --scripts
	    The directory for custom javascript files can be either set in  con-
	    fig.xml or with this command line option.

     -f, --magic
	    The  magic file is set/overwritten. By default it is read from envi-
	    ronment variables GERBERA_MAGIC_FILE or MEDIATOMB_MAGIC_FILE.

     --add-file
	    Add the specified file name to the database without UI  interaction.
	    The  path  must  be absolute, if path is a directory then it will be
	    added recursively. If path is a file, then only the given file  will
	    be imported.

     --print-options
	    Print all option numbers available for use with --set-option.

     --set-option
	    Set  the  specified  option  number to its proper value like in con-
	    fig.xml. This overwrites values from config.xml. See --print-options
	    for valid options.	Multiple options can either be	specified  sper-
	    ated by commas or with another use of --set-option.

     -l, --logfile
	    Do	not  output log messages to stdout, but redirect everything to a
	    specified file.

     -l, --rotatelog
	    Do not output log messages to stdout, but redirect everything  to  a
	    specified rotating file. It will rotate 10 files at 5MB.

     -l, --syslog
	    Do	not  output  log  messages to stdout, but redirect everything to
	    syslog. The optional argument contains the syslog  facility.  If  no
	    argument is given LOG_USER is used.

     -D, --debug
	    Enable debug log output.

     -d, --daemon
	    Daemonize after startup.

     --compile-info
	    Print the compilation configuration (defaults for used libraries and
	    enabled features) and exit.

     --create-config=Section

     --create-example-config=Section

     --create-advanced-config=Section
	    Output  the default/example/advanced example configuration to stdout
	    and exit.  Copy the output to your config.xml  and	adjust	to  your
	    needs.   You can provide the names of sections separated by | to get
	    the section only.

     --modules=Module
	    Activate generation of from-file attributes in Module.  You can pro-
	    vide the names of modules separated by | to load  multiple	sections
	    as modules.

     --check-config
	    Check the current configuration before running the service and exit.
	    Helpful in conjunction with --debug.

     --offline
	    Do	not  answer UPnP requests like browse. This is helpful when run-
	    ning a large scan to initialize the database so no client  can  slow
	    down the import by accessing the database.

     --drop-tables
	    Drop all database tables and exit

     --init-lastfm
	    Get  Last.FM  session  key	based on apiKey and apiSecret in config.
	    Requires Gerbera to be build with support for Last.FM API 2.0.

     --version
	    Print version information and exit.

     -h, --help
	    Print a summary about the available command line options.

				   2025-10-17			      gerbera(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=gerbera&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help