Files
mRemoteNG/mRemoteV1/Documentation/troubleshooting.rst
Faryan Rezagholi 4e118493d2 Sphinx docs (#1384)
* included changes from @nmat from separate repo into mrng

* added sphinx-doc build dir

* fixed error on non-appveyor builds

* removed unneccesary variable

* added post-build script for sphinx documenatation

* retired "move_help_files" post build script

* added sphinx-documentation files to project

* display spinx docs

* changed theme to read the docs

* fixed typo

* restructured sphinx dir

* added documentation forr keyboard shortcuts and command line switches

* more hierarchy fixes

* added known issues

* added images for sphinx docs to project

* added quick connect documentation

* added port scan documentation

* added screenshot manager documentation

* added notifications documentation

* added import/export documentation

* added ssh file transfer documentation

* added connection config documentation

* added options documentation

* added menus documentation

* converted remaining help files and tidied up resources

* fixed formatting error

* modified sphinx script to automatically grab assembly details from assembly file

* modified copyright string for automated sphinx builds

* splitted toctree

* added RTD configuration file

* added RTD badge

* use default values if assembly file cannot be found

* removed colons from headings

* Minor fixes

* Remove source link so its not confusing for users

* Fix minor spelling

* Add editorconfig for rst files

* added external tools cheat sheet

* extended known issues segment

* added contact information

* Fix list item in document:

* Under "Opening and Closing Connections"

* added infor on how to migrate from pre-NG versions

* fixed list not being rendered properly

* removed markup guide from help to move it to the github wiki

* added missing information from github wiki

* removed contributing document from repository itself to move it to the wiki

* fixed formatting error

* Add more information for import/export

* minor wording fixes

* moved troubleshooting and known issues to its own support section

* moved "folders and inheritance" under "application handling"

* Minor formatting fixes

* Formatting fixes

* Updated docs for ssh file transfer:

* Added screenshot

* Updated documentation a little

* added FAQ

* revised external tools

* fixed sphinx build errors

* changed heading format

* do not output images for sphinx docs to build dir

* removed issue/pr templates

* updated appveyer configuration

* added missing variables

* added python to path

* output PATH for debugging

* sphinx build tests

* Minor cleanup

* added sql script changes into sphinx docs

* removed unused appveyor.xml
2019-04-30 21:42:32 +02:00

70 lines
2.5 KiB
ReStructuredText

***************
Troubleshooting
***************
Logfile
=======
The mRemoteNG.log is located in the following location:
MSI/Installed version
---------------------
::
%APPDATA%\mRemoteNG\mRemoteNG.log
(example: `C:\Users\[username]\AppData\Roaming\mRemoteNG\mRemoteNG.log`)
Portable version
----------------
::
[location of mRemoteNG.exe]\mRemoteNG.log
Crash at Startup
================
Try deleting your `user.config <https://github.com/mRemoteNG/mRemoteNG/wiki/User-settings-file>`_ file, see https://support.microsoft.com/en-us/kb/956762
Crash Information
=================
- Provide the Stack Trace from the crash prompt or from the Windows Application Event Log `example <https://blogs.msdn.microsoft.com/cobold/2010/03/01/collecting-crash-dumps/>`_)
- Check `C:\Users\All Users\Microsoft\Windows\WER\Report*` folders for any reports related to mRemoteNG
- Check `%LOCALAPPDATA%\CrashDumps <https://msdn.microsoft.com/en-us/library/windows/desktop/bb787181(v=vs.85).aspx>`_ for any mRemoteNG.exe.*.dmp files
- Attach the Error Reports, Dumps and mRemoteNG.log to a new `Issue <https://github.com/mRemoteNG/mRemoteNG/issues>`_
Backup and Recovery
===================
By default, your connections file is backed up every time it is saved.
These backup files are normal/valid connections file - they have only been renamed to avoid being overwritten.
mRemoteNG will save the 10 most recent backups.
Files and Locations
-------------------
Your backup files are located in the same place as your normal connections file.
This could be one of three places:
- Normal version: `%AppData%\mRemoteNG`
- Portable version: In the same location as mRemoteNG.exe
- If you have saved your confCons.xml to a custom location, go there.
There are 2 different backup naming schemes:
- `confCons.xml.backup` is the most recent backup that was taken.
- `confCons.xml.YYYYMMDD-HHmmssxxxx.backup` is a rolling backup that was moved to a rolling backup file on the date specified in the file name.
Recovering corrupted connections file
-------------------------------------
If you find that your confCons.xml file has corrupted or has lost its data,
you will need to revert to a previous version.
- Locate your confCons.xml file
- Find the most recent backup file that appears to have data (>1KB in size).
- Rename or delete the corrupted `confCons.xml` file.
- Rename the chosen backup file to remove the date stamp and .backup suffix. Unless you set a custom path, your backup file should now be named `confCons.xml`.