Difference between revisions of "Command Line User Guide"
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | Use '''ssh''' to remotely access the console (terminal) of the Zynthian from another computer. Use the '''ssh''' command in Mac Terminal or use the freely downloadable '''PuTTY''' software for Windows. You need to know the IP address of the Zynthian on your local network to use ssh. See [[Finding your IP address]] for help on this. | ||
=SSH/SFTP access:= | =SSH/SFTP access:= | ||
| − | login: root | + | login: root |
| − | + | password: raspberry | |
| − | password: raspberry | ||
User pi doesn't exist any more and ... it's a good idea to change the password :wink: | User pi doesn't exist any more and ... it's a good idea to change the password :wink: | ||
| Line 9: | Line 9: | ||
=Base Directory:= | =Base Directory:= | ||
| − | /zynthian | + | /zynthian |
| + | |||
Almost all the zynthian stuff like synth engines, audio plugins, soundfonts, zynthian user interface, setup scripts and other specific software is in this directory. | Almost all the zynthian stuff like synth engines, audio plugins, soundfonts, zynthian user interface, setup scripts and other specific software is in this directory. | ||
=UI configuration file= | =UI configuration file= | ||
| − | /zynthian/zynthian-ui/zynthian_gui_config.py | + | /zynthian/zynthian-ui/zynthian_gui_config.py |
| + | |||
This file contains some configuration parameters for the Zynthian User Interface: | This file contains some configuration parameters for the Zynthian User Interface: | ||
| Line 21: | Line 23: | ||
* Font & Color scheme | * Font & Color scheme | ||
* etc. | * etc. | ||
| − | =Stopping/Starting Zynthian UI= | + | =Stopping/Starting the Zynthian UI= |
You must use systemd-style commands to stop & start any system service, that includes the zynthian UI: | You must use systemd-style commands to stop & start any system service, that includes the zynthian UI: | ||
| − | + | systemctl stop zynthian | |
| − | + | systemctl start zynthian | |
| − | If you want to run the | + | |
| + | If you want to run the Zynthian UI in the console, you must stop the zynthian service and run the zynthian UI as a normal script using these commands: | ||
| + | |||
| + | systemctl stop zynthian | ||
| + | /zynthian/zynthian-sys/sbin/zynthian.sh | ||
| + | |||
| + | Running zynthian from the console (terminal) allows you to view the logging/debug messages, which is necessary for debugging (posting these to the forum will enable experts to help you.) | ||
| + | =Viewing the Zynthian graphics display on a computer= | ||
| + | If you are using Linux on your PC (or MacOSX with a X window server installed), you can login into your Zynthian box with '''ssh''' using the “-Y” flag: | ||
| + | |||
| + | ssh -Y root@zynthian.local | ||
| + | |||
| + | this will allow you to run graphic applications in your Zynthian, while displaying the graphics window on your PC/laptop. | ||
| + | =Debugging MIDI= | ||
| + | You can use commands to see what's going on with MIDI I/O | ||
| + | [[Debugging MIDI]] | ||
| + | |||
| + | =More detailed info= | ||
| − | + | More info on this page [[Accessing_Zynthian_from_your_computer]] | |
| − | |||
Revision as of 17:32, 21 November 2017
Use ssh to remotely access the console (terminal) of the Zynthian from another computer. Use the ssh command in Mac Terminal or use the freely downloadable PuTTY software for Windows. You need to know the IP address of the Zynthian on your local network to use ssh. See Finding your IP address for help on this.
1 SSH/SFTP access:
login: root password: raspberry
User pi doesn't exist any more and ... it's a good idea to change the password :wink:
2 Base Directory:
/zynthian
Almost all the zynthian stuff like synth engines, audio plugins, soundfonts, zynthian user interface, setup scripts and other specific software is in this directory.
3 UI configuration file
/zynthian/zynthian-ui/zynthian_gui_config.py
This file contains some configuration parameters for the Zynthian User Interface:
- Logging level
- Wiring layout
- Font & Color scheme
- etc.
4 Stopping/Starting the Zynthian UI
You must use systemd-style commands to stop & start any system service, that includes the zynthian UI:
systemctl stop zynthian systemctl start zynthian
If you want to run the Zynthian UI in the console, you must stop the zynthian service and run the zynthian UI as a normal script using these commands:
systemctl stop zynthian /zynthian/zynthian-sys/sbin/zynthian.sh
Running zynthian from the console (terminal) allows you to view the logging/debug messages, which is necessary for debugging (posting these to the forum will enable experts to help you.)
5 Viewing the Zynthian graphics display on a computer
If you are using Linux on your PC (or MacOSX with a X window server installed), you can login into your Zynthian box with ssh using the “-Y” flag:
ssh -Y root@zynthian.local
this will allow you to run graphic applications in your Zynthian, while displaying the graphics window on your PC/laptop.
6 Debugging MIDI
You can use commands to see what's going on with MIDI I/O Debugging MIDI
7 More detailed info
More info on this page Accessing_Zynthian_from_your_computer