Skip to content

Commit

Permalink
Update module help
Browse files Browse the repository at this point in the history
  • Loading branch information
rhymeswithmogul committed Dec 24, 2020
1 parent 01a223b commit 73bf59a
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 81 deletions.
74 changes: 55 additions & 19 deletions en-US/about_RdpToolkit.help.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
TOPIC
about_rdptoolkit
about_RdpToolkit

SHORT DESCRIPTION
RdpToolkit creates and manipulates Remote Desktop Connection files.
Expand All @@ -12,20 +12,46 @@ LONG DESCRIPTION
Compatibility
.rdp files are used by the Remote Desktop Connection app (mstsc.exe) built
in to most versions of Windows. They are also used by the Microsoft Remote
Desktop app for Windows 10, macOS, iOS, iPadOS, and Android. Many
third-party or open-source apps should support reading a .rdp file, too.
This module creates .rdp files that follow the most recent specifications.
Older RDP clients will ignore any lines that they do not understand.
Desktop app for Windows 10, macOS, iOS, iPadOS, and Android. Many third-
party or open-source apps should support reading a .rdp file, too. This
module creates .rdp files that follow the most recent specifications. Older
RDP clients will ignore any lines that they do not understand.

Digital Signatures
.rdp files can have a digital signature attached. Signed .rdp files prevent
the user from changing most settings. In addition, they will see fewer
warnings, and they will see the signer's name.
the user from changing most settings. In addition to this, the end user will
see fewer warnings, and they will see the signer's name.

The downside of this is that the digital signatures applied to .rdp files do
not support timestamping (like Authenticode does). Once the code signing
certificate expires or is revoked, the .rdp file becomes unusable. Anyone
attempting to use it will only get an error message about the signature
being invalid.
certificate expires or is revoked, the .rdp file becomes unusable! Anyone
attempting to use it will only get an error saying the digital signature
is invalid or cannot be verified.

Supported Properties
The following Remote Desktop Protocol connection properties are supported,
or partially supported, by this module:

- alternate full address
- audiocapturemode
- camerastoredirect (partial)
- devicestoredirect
- domain
- drivestoredirect (partial)
- full address
- gatewaycredentialssource (partial)
- gatewayhostname
- gatewayprofileusagemethod (partial)
- gatewayusagemethod (partial)
- promptcredentialonce
- redirectclipboard
- redirectcomports
- redirectprinters
- redirectsmartcards
- singlemoninwindowedmode (partial)
- usbdevicestoredirect (partial)
- use multimon
- username

EXAMPLES
The most powerful cmdlet included with this module (at this time) is very
Expand All @@ -35,13 +61,21 @@ EXAMPLES
>> -UserName '[email protected]' -Redirect Drives,Cameras,AudioCapture

As specified, this will create the file Work.rdp. The file will connect you
to WorkPC.contoso.local. The default username will be
[email protected]. On connecting, all of the local computer's drives,
cameras, and microphones will be available in the remote session.
to WorkPC.contoso.local. The default username will be [email protected].
On connecting, all of the local computer's drives, cameras, and microphones
will be available in the remote session.

If you were to do a (Get-Content 'Work.rdp'), you would see this:
audiocapturemode:i:1 camerastoredirect:s:* domain:s: drivestoredirect:s:*
full address:s:WorkPC.contoso.local redirectsmartcards:i:0
singlemoninwindowedmode:i:1 use multimon:i:1 username:s:[email protected]
audiocapturemode:i:1
camerastoredirect:s:*
domain:s:
drivestoredirect:s:*
full address:s:WorkPC.contoso.local
redirectsmartcards:i:0
singlemoninwindowedmode:i:1
use multimon:i:1
username:s:[email protected]

For more information and further examples, run Get-Help on each of the
functions in this module.

Expand All @@ -56,13 +90,15 @@ TROUBLESHOOTING NOTE
GitHub page.

SEE ALSO
New-RdcFile Add-RdcFileSignature Remove-RdcFileSignature
New-RdcFile
Add-RdcFileSignature
Remove-RdcFileSignature
https://github.com/rhymeswithmogul/RdpToolkit
https://docs.microsoft.com/en-us/windows-server/remote/remote-desktop-services/clients/rdp-files

KEYWORDS
Some keywords you might use to search for this module include: - Remote
Desktop Connection (RDC)
Some keywords you might use to search for this module include:
- Remote Desktop Connection (RDC)
- Remote Desktop Protocol (RDP)
- Terminal Services Connection (MSTSC.exe)
- Microsoft Remote Desktop Connection (MSRDC)
Expand Down
62 changes: 0 additions & 62 deletions man/en-US/about_RdpToolkit.md

This file was deleted.

0 comments on commit 73bf59a

Please sign in to comment.